lyrically 2.0.0

A music lyric scraper

lyrically

A music lyric scraper

---

Features

• Development Tools: Includes uv, mypy, ruff, pre-commit, and commitizen

---

Installation

From PyPI (Recommended)

pip install lyrically

From Source

You can install lyrically by cloning the repository directly.

Prerequisites: This project requires uv for dependency management.

1. Clone the repository:

   git clone https://github.com/filming/lyrically.git
   cd lyrically
   

2. Install the project and its dependencies:

   uv sync
   

---

Usage

Usage examples wiil be added later.

---

Development

This project uses modern Python development tools:

• uv for dependency management
• ruff for linting and formatting
• mypy for type checking
• pre-commit for git hooks
• commitizen for conventional commits

Setting up for development:

1. Clone the repository:

   git clone https://github.com/filming/lyrically.git
   cd lyrically
   

2. Install dependencies (including dev tools):

   uv sync --extra dev
   

3. Set up pre-commit hooks:

   uv run pre-commit install
   

4. Start developing!

---

Dependencies

All project dependencies are managed via pyproject.toml and use Python 3.10+.

---

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Contributing

Contributions, bug reports, and feature requests are welcome! Please open an issue or submit a pull request on GitHub.