development.md

Development

Prerequisites

• Python 3.12 or higher
• Poetry for dependency management

How to Set Up

1. Fork the repository.
2. Run source start.sh to activate the virtual environment.
3. Install dependencies with poetry install.
4. Make your changes.

How to Migrate the Database

To create a new migration, use:

alembic revision --autogenerate -m "your message here"

To apply migrations, use:

alembic upgrade head

How to Seed the Database

To seed the database with sample data, run:

make seed

To cleanup, run:

make seed-cleanup

How to Test

To run tests, use:

make test

To run integration tests, use:

make test-integration

How to Publish to PyPI

Note: You need to have the PyPI token set in your environment variables to publish the package.

To build the project, run:

make build

To publish the project, run:

make publish