Metadata-Version: 2.1
Name: lrcup
Version: 0.2
Summary: Python module and CLI for the LRCLIB API
Project-URL: Homepage, https://github.com/iiPythonx/lrcup
Project-URL: Issues, https://github.com/iiPythonx/lrcup/issues
Author-email: iiPython <ben@iipython.dev>
License-File: LICENSE.txt
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Requires-Dist: click
Requires-Dist: mutagen
Requires-Dist: requests
Description-Content-Type: text/markdown

# LRCUP

Python CLI and library for interacting with the [LRCLIB.net API](https://lrclib.net/).

## Installation

Install via PyPI:
```sh
pip install lrcup
```

## CLI Usage

```py
# If you have an unsynced/synced LRC file:
lrcup upload example.lrc

# If you have a track with embedded lyrics:
lrcup upload file.flac
```

## Module Usage

The class method names are based off of the LRCLIB API endpoints.  
Please refer to them for more information.

```py
from lrcup import LRCLib

lrclib = LRCLib()

# Example of getting synced lyrics via search
results = lrclib.search(
    track = "Never gonna give you up",
    artist = "Rick Astley"
)
print(results[0]["syncedLyrics"])
```
