This service is composed by:
accounting-service: main service.
Requirements:
- Docker compose >= 2.24.4
- uv
Valid make targets:
help Show this help
install Install dependencies into .venv
compile-deps Create or update the lock file, without upgrading the version of the dependencies
upgrade-deps Create or update the lock file, using the latest version of the dependencies
check-deps Check that the dependencies in the existing lock file are valid
lint Run linters
build Build the docker images
run Run the application in docker
kill Take down the application and remove the volumes
clean Take down the application and remove the volumes and the images
test Run tests in docker
test-local Run tests locally
migration Create the alembic migration
show-config Show the docker-compose configuration in the current environment
sh Run a shell in the app container
To build and start the Docker images locally, you can execute:
make runTo make a release, build and publish the Docker image to the registry, you need to:
- create a release through the GitHub UI (recommended), or
- push a tag to the main branch using git.
The format of the tag should be YYYY.M.N, where:
YYYYis the full year (2024, 2025 ...)Mis the short month, not zero-padded (1, 2 ... 11, 12)Nis any incremental number, not zero-padded (it doesn't need to be the day number)
The API documentation is available locally at http://127.0.0.1:8100/docs after the local deployment.
The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government's ETH Board of the Swiss Federal Institutes of Technology.
Copyright © 2024 Blue Brain Project/EPFL