| Name | lyrically JSON |
| Version |
2.2.0
JSON |
| download |
| home_page | None |
| Summary | An asynchronous Python client for fetching complete artist lyrical discographies from the web. |
| upload_time | 2025-07-11 20:55:00 |
| maintainer | None |
| docs_url | None |
| author | Filming |
| requires_python | >=3.10 |
| license | MIT License
Copyright (c) 2025 Filming
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
artists
async
azlyrics
discography
lyrics
lyrics-scraper
music
music-data
python
python3
scraping
songs
web-scraping
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# lyrically
Lyrically is a high-performance, asynchronous Python tool designed to fetch entire artist lyrical discographies, storing them locally in a structured SQLite database.
---
## Features
* **Development Tools:** Includes uv, mypy, ruff, pre-commit, and commitizen
---
## Installation
### From PyPI (Recommended)
```bash
pip install lyrically
```
### From Source
You can install lyrically by cloning the repository directly.
**Prerequisites:** This project requires [uv](https://github.com/astral-sh/uv) for dependency management.
1. Clone the repository:
```bash
git clone https://github.com/filming/lyrically.git
cd lyrically
```
2. Install the project and its dependencies:
```bash
uv sync
```
---
## Usage
```
Usage examples wiil be added later.
```
---
## Development
This project uses modern Python development tools:
- **[uv](https://github.com/astral-sh/uv)** for dependency management
- **[ruff](https://github.com/astral-sh/ruff)** for linting and formatting
- **[mypy](https://mypy.readthedocs.io/)** for type checking
- **[pre-commit](https://pre-commit.com/)** for git hooks
- **[commitizen](https://commitizen-tools.github.io/commitizen/)** for conventional commits
### Setting up for development:
1. Clone the repository:
```bash
git clone https://github.com/filming/lyrically.git
cd lyrically
```
2. Install dependencies (including dev tools):
```bash
uv sync --extra dev
```
3. Set up pre-commit hooks:
```bash
uv run pre-commit install
```
4. Start developing!
---
## Dependencies
All project dependencies are managed via [`pyproject.toml`](pyproject.toml) and use Python 3.10+.
---
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
## Contributing
Contributions, bug reports, and feature requests are welcome!
Please open an issue or submit a pull request on [GitHub](https://github.com/filming/lyrically).
Raw data
{
"_id": null,
"home_page": null,
"name": "lyrically",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "artists, async, azlyrics, discography, lyrics, lyrics-scraper, music, music-data, python, python3, scraping, songs, web-scraping",
"author": "Filming",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/48/72/6e83b5f6b58981106d485c628ff3a8cd72b61135fe099901975c72dc4c02/lyrically-2.2.0.tar.gz",
"platform": null,
"description": "# lyrically\n\nLyrically is a high-performance, asynchronous Python tool designed to fetch entire artist lyrical discographies, storing them locally in a structured SQLite database.\n\n---\n\n## Features\n\n* **Development Tools:** Includes uv, mypy, ruff, pre-commit, and commitizen\n\n---\n\n## Installation\n\n\n### From PyPI (Recommended)\n\n```bash\npip install lyrically\n```\n\n### From Source\n\n\nYou can install lyrically by cloning the repository directly.\n\n**Prerequisites:** This project requires [uv](https://github.com/astral-sh/uv) for dependency management.\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/filming/lyrically.git\n cd lyrically\n ```\n\n2. Install the project and its dependencies:\n ```bash\n uv sync\n ```\n\n---\n\n## Usage\n\n```\nUsage examples wiil be added later.\n```\n\n---\n\n## Development\n\nThis project uses modern Python development tools:\n\n- **[uv](https://github.com/astral-sh/uv)** for dependency management\n- **[ruff](https://github.com/astral-sh/ruff)** for linting and formatting \n- **[mypy](https://mypy.readthedocs.io/)** for type checking\n- **[pre-commit](https://pre-commit.com/)** for git hooks\n- **[commitizen](https://commitizen-tools.github.io/commitizen/)** for conventional commits\n\n### Setting up for development:\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/filming/lyrically.git\n cd lyrically\n ```\n\n2. Install dependencies (including dev tools):\n ```bash\n uv sync --extra dev\n ```\n\n3. Set up pre-commit hooks:\n ```bash\n uv run pre-commit install\n ```\n \n4. Start developing!\n\n---\n\n## Dependencies\n\nAll project dependencies are managed via [`pyproject.toml`](pyproject.toml) and use Python 3.10+.\n\n---\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\n## Contributing\n\nContributions, bug reports, and feature requests are welcome!\nPlease open an issue or submit a pull request on [GitHub](https://github.com/filming/lyrically).\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Filming\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "An asynchronous Python client for fetching complete artist lyrical discographies from the web.",
"version": "2.2.0",
"project_urls": {
"Changelog": "https://github.com/filming/lyrically/blob/master/CHANGELOG.md",
"Homepage": "https://github.com/filming/lyrically",
"Issues": "https://github.com/filming/lyrically/issues",
"Repository": "https://github.com/filming/lyrically"
},
"split_keywords": [
"artists",
" async",
" azlyrics",
" discography",
" lyrics",
" lyrics-scraper",
" music",
" music-data",
" python",
" python3",
" scraping",
" songs",
" web-scraping"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "faa5df43cb07ae254e453d686e8ee100a75163ea0aceff22945343ad42a4f1ef",
"md5": "36d1151b1af7f886d9db98265ab9c1d9",
"sha256": "90dd639e05bd7297f953789c70e99370e997263710028a3b23fdb0bf8e043bcc"
},
"downloads": -1,
"filename": "lyrically-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "36d1151b1af7f886d9db98265ab9c1d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6622,
"upload_time": "2025-07-11T20:54:59",
"upload_time_iso_8601": "2025-07-11T20:54:59.707041Z",
"url": "https://files.pythonhosted.org/packages/fa/a5/df43cb07ae254e453d686e8ee100a75163ea0aceff22945343ad42a4f1ef/lyrically-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "48726e83b5f6b58981106d485c628ff3a8cd72b61135fe099901975c72dc4c02",
"md5": "3257b1e8df9f80c35da08519f72d770f",
"sha256": "659281971a38c47d1e6a15882f9e4906b47c5bb3b9d6eaf390781ec20c49de51"
},
"downloads": -1,
"filename": "lyrically-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "3257b1e8df9f80c35da08519f72d770f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 79741,
"upload_time": "2025-07-11T20:55:00",
"upload_time_iso_8601": "2025-07-11T20:55:00.799963Z",
"url": "https://files.pythonhosted.org/packages/48/72/6e83b5f6b58981106d485c628ff3a8cd72b61135fe099901975c72dc4c02/lyrically-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-11 20:55:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "filming",
"github_project": "lyrically",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lyrically"
}
