Contributions to alexandria are very welcome! Best have a look at the open issues and open a GitHub pull request. See instructions below how to setup development environment. Before writing any code, best discuss your proposed change in a GitHub issue to see if the proposed change makes sense for the project.
To work on alexandria you first need to clone
git clone https://github.com/projectcaluma/alexandria.git
cd alexandria
Once it is cloned you can easily open a shell in the docker container to open an development environment.
# needed for permission handling
# only needs to be run once
echo UID=$UID > .env
# open shell
docker compose run --rm alexandria bash
Once you have shelled in docker container as described above you can use common python tooling for formatting, linting, testing etc.
# linting
poetry run ruff check .
# format code
poetry run ruff format .
# running tests
poetry run pytest
# create migrations
poetry run ./manage.py makemigrations
Writing of code can still happen outside the docker container of course.
In case you're adding new requirements you simply need to build the docker container again for those to be installed and re-open shell.
docker compose build --pull
Pre commit hooks is an additional option instead of executing checks in your editor of choice.
First create a virtualenv with the tool of your choice before running below commands:
poetry install
poetry run pre-commit install --hook=pre-commit
poetry run pre-commit install --hook=commit-msg
You will need to have exiftool
installed on your os.