Custody

Develop

You need pyenv and poetry available in development environment.

1. Setup Python version specified in .python-version

pyenv install

2. Prepare virtual environment with required dependencies and activate it

poetry install
poetry shell

3. Setup pre-commit git hooks to automate code quality check

poetry run pre-commit install

4. Create .env and specify arguments

cp .env.example

5. Run migrations

alembic upgrade head

6. Run app

On a localhost

python -m custody

Or in a container

docker compose up

Deploy

With Docker CLI

1. Load environment variables

export $(cat .env | xargs)

2. Deploy stack to Docker Swarm cluster

docker stack deploy -c docker-compose.yml -c docker-compose.prod.yml <stack_name>

With Ansible

ANSIBLE_CONFIG=/path/to/ansible.cfg ansible-playbook -i /path/to/hosts.yml deploy.yml