Lyrix is a Python bot designed to periodically tweet song lyrics.
This program will periodically fetch lyrics from a local database of a specific music artist, album and/or track, validate their lyrical appeal using an AI model and them post them to an X (formerly Twitter) account.
Features list wiil be added later.
You can install Lyrix by cloning the repository directly.
Prerequisites: This project requires uv for dependency management.
-
Clone the repository:
git clone https://github.com/filming/lyrix.git cd lyrix -
Install the project and its dependencies:
uv sync
Usage examples wiil be added later.
This project uses modern Python development tools such as:
- uv for dependency management
- ruff for linting and formatting
- mypy for type checking
- pre-commit for git hooks
- commitizen for conventional commits
-
Clone the repository:
git clone https://github.com/filming/lyrix.git cd lyrix -
Setup developement environment using Makefile:
make setup
-
Start developing!
All project dependencies are managed via pyproject.toml and use Python 3.10+.
This project is licensed under the MIT License - see the LICENSE file for details.
Contributions, bug reports, and feature requests are welcome! Please open an issue or submit a pull request on GitHub.