Metadata-Version: 2.1
Name: chartlyrics
Version: 0.1.1
Summary: Wrapper for chartlyrics api: http://api.chartlyrics.com
Home-page: https://github.com/python-poetry/poetry
License: MIT
Author: matheusfillipe
Author-email: matheusfillipeag@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: lxml (>=4.9.1,<5.0.0)
Requires-Dist: requests (>=2.28.1,<3.0.0)
Project-URL: Repository, https://github.com/matheusfillipe/chartlyrics
Description-Content-Type: text/markdown

# ChartLyrics API

This is a simple wrapper for: http://api.chartlyrics.com. You can search for songs, artists and get the lyrics.

## Installation

``` sh
pip install chartlyrics
```

## Usage Example

```python
from chartlyrics import ChartLyricsClient

client = ChartLyricsClient()

for song in client.search_text("starts with one"):
    if "park" in song.artist.lower():
      print(song.artist)  # Linking Park
      print(song.lyrics)  # Starts with one\n One thing I dont know why...
    
```

You can also use `song.lyrics_object` which will return a `Lyrics` object that you can index strophes and verses on:

Check the `tests` for more examples.

## Development

Fork the repo, run:

``` sh
poetry install
```

Add features, write tests, run:

``` sh
poetry run pytest
```

Create a Pull request.

