| Name | melodic JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | A Python client for fetching artist lyrical discographies. |
| upload_time | 2025-07-21 22:54:44 |
| 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 |
artist-data
async
azlyrics
database
discography
lyrics
music
python
web-scraping
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Melodic
<p align="center">
<a href="https://pypi.org/project/melodic/"><img alt="PyPI" src="https://img.shields.io/pypi/v/melodic?color=blue"></a>
<a href="https://pypi.org/project/melodic/"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/melodic"></a>
<a href="https://opensource.org/licenses/MIT"><img alt="License" src="https://img.shields.io/badge/License-MIT-yellow.svg"></a>
</p>
Melodic is a Python client for fetching artist lyrical discographies. This library provides an asynchronous interface to retrieve complete artist discographies from AZLyrics, including album metadata and song lyrics, with built-in database storage, proxy support, and robust error handling.
It's your solution for effortlessly collecting and organizing the complete lyrical works of your favorite artists. Build a comprehensive library for data analysis, power a creative project, or simply enjoy having all the words at your fingertips.
---
## Features
- **Complete Discography Fetching:** Retrieves full album and track listings for any given artist.
- **Asynchronous Interface:** Built with modern `async with` patterns for efficient, safe I/O operations.
- **Database Storage:** Optional built-in storage system for organizing artist, album, and track metadata.
- **Proxy Support:** Easily pass a list of proxies to route requests through.
- **Robust Error Handling:** Comprehensive error handling and logging for reliable operation.
- **Modern Development Tools:** Includes ruff, mypy, pre-commit, and commitizen for high-quality code.
---
## Installation
### From PyPI (Recommended)
```bash
pip install melodic
```
### From Source
You can install melodic 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/melodic.git
cd melodic
```
2. Install the project and its dependencies:
```bash
uv sync
```
---
## Usage
```
Usage example will be shown in the future.
```
---
## Configuration
Configuration is passed directly to the `Melodic` class instance during initialization.
- **`storage_dir`**: An optional string or `Path` object pointing to a directory where the database and other files will be stored. If not provided, no data will be saved to disk.
- **`proxies`**: An optional list of proxy strings (e.g., `["http://user:pass@host:port"]`). If provided, all network requests will be routed through these proxies.
---
## 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/melodic.git
cd melodic
```
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/melodic).
Raw data
{
"_id": null,
"home_page": null,
"name": "melodic",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "artist-data, async, azlyrics, database, discography, lyrics, music, python, web-scraping",
"author": "Filming",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/8d/7f/ddc21a908060c841d6a0835eb00f5c3babfe097dbfdebc3493a2e46b313a/melodic-1.1.0.tar.gz",
"platform": null,
"description": "# Melodic\n\n<p align=\"center\">\n <a href=\"https://pypi.org/project/melodic/\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/melodic?color=blue\"></a>\n <a href=\"https://pypi.org/project/melodic/\"><img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/melodic\"></a>\n <a href=\"https://opensource.org/licenses/MIT\"><img alt=\"License\" src=\"https://img.shields.io/badge/License-MIT-yellow.svg\"></a>\n</p>\n\nMelodic is a Python client for fetching artist lyrical discographies. This library provides an asynchronous interface to retrieve complete artist discographies from AZLyrics, including album metadata and song lyrics, with built-in database storage, proxy support, and robust error handling.\n\nIt's your solution for effortlessly collecting and organizing the complete lyrical works of your favorite artists. Build a comprehensive library for data analysis, power a creative project, or simply enjoy having all the words at your fingertips.\n\n---\n\n## Features\n\n- **Complete Discography Fetching:** Retrieves full album and track listings for any given artist.\n- **Asynchronous Interface:** Built with modern `async with` patterns for efficient, safe I/O operations.\n- **Database Storage:** Optional built-in storage system for organizing artist, album, and track metadata.\n- **Proxy Support:** Easily pass a list of proxies to route requests through.\n- **Robust Error Handling:** Comprehensive error handling and logging for reliable operation.\n- **Modern Development Tools:** Includes ruff, mypy, pre-commit, and commitizen for high-quality code.\n\n---\n\n## Installation\n\n### From PyPI (Recommended)\n\n```bash\npip install melodic\n```\n\n### From Source\n\nYou can install melodic 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/melodic.git\n cd melodic\n ```\n\n2. Install the project and its dependencies:\n ```bash\n uv sync\n ```\n\n---\n\n## Usage\n\n```\nUsage example will be shown in the future.\n```\n\n---\n\n## Configuration\n\nConfiguration is passed directly to the `Melodic` class instance during initialization.\n\n- **`storage_dir`**: An optional string or `Path` object pointing to a directory where the database and other files will be stored. If not provided, no data will be saved to disk.\n- **`proxies`**: An optional list of proxy strings (e.g., `[\"http://user:pass@host:port\"]`). If provided, all network requests will be routed through these proxies.\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/melodic.git\n cd melodic\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/melodic).\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": "A Python client for fetching artist lyrical discographies.",
"version": "1.1.0",
"project_urls": {
"Changelog": "https://github.com/filming/melodic/blob/master/CHANGELOG.md",
"Homepage": "https://github.com/filming/melodic",
"Issues": "https://github.com/filming/melodic/issues",
"Repository": "https://github.com/filming/melodic"
},
"split_keywords": [
"artist-data",
" async",
" azlyrics",
" database",
" discography",
" lyrics",
" music",
" python",
" web-scraping"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "37f9dd0ba81c301b0f47a49b1d035721262f370d7d5c0ed8414fe35a25b45f0e",
"md5": "a85a9ee25937d3bd91d04f950d5ea6b5",
"sha256": "6719dbe59c64f926cded24a9fad9cd64414ca3af7925f5a1f67ff36432fbacd1"
},
"downloads": -1,
"filename": "melodic-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a85a9ee25937d3bd91d04f950d5ea6b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 10167,
"upload_time": "2025-07-21T22:54:42",
"upload_time_iso_8601": "2025-07-21T22:54:42.197326Z",
"url": "https://files.pythonhosted.org/packages/37/f9/dd0ba81c301b0f47a49b1d035721262f370d7d5c0ed8414fe35a25b45f0e/melodic-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8d7fddc21a908060c841d6a0835eb00f5c3babfe097dbfdebc3493a2e46b313a",
"md5": "f0a4ec5d54ad3f2dc1def053586465b1",
"sha256": "f84c9053fc7ac61be65e3d6da185335163e32814f2b41e6fc798c363fa56bbe5"
},
"downloads": -1,
"filename": "melodic-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f0a4ec5d54ad3f2dc1def053586465b1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 54817,
"upload_time": "2025-07-21T22:54:44",
"upload_time_iso_8601": "2025-07-21T22:54:44.675554Z",
"url": "https://files.pythonhosted.org/packages/8d/7f/ddc21a908060c841d6a0835eb00f5c3babfe097dbfdebc3493a2e46b313a/melodic-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-21 22:54:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "filming",
"github_project": "melodic",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "melodic"
}
