Repository files navigation

Keeps track of mumble instances ordered by people in different contexts

For more controlled deployments and to get rid of "works on my computer" -syndrome, we alwaysmake sure our software works under docker.

It's also a quick way to get started with a standard development environment:

docker-compose -p pttbackend -f docker-compose_local.yml -f docker-compose_local_reload.yml up

Note that you need jwt.pub from the a11napi instance you're using to get your auth tokens (/api/v1/tokens/pubkey)

We needbuildkit:

export DOCKER_BUILDKIT=1

And also the exact way for forwarding agent to running instance is different on OSX:

export DOCKER_SSHAGENT="-v /run/host-services/ssh-auth.sock:/run/host-services/ssh-auth.sock -e SSH_AUTH_SOCK=/run/host-services/ssh-auth.sock"

and Linux:

export DOCKER_SSHAGENT="-v $SSH_AUTH_SOCK:$SSH_AUTH_SOCK -e SSH_AUTH_SOCK"

Build image, create container and start it:

docker build --ssh default --target devel_shell -t pttbackend:devel_shell .docker create --name pttbackend_devel -v `pwd`":/app" -it `echo $DOCKER_SSHAGENT` pttbackend:devel_shelldocker start -i pttbackend_devel

If working in Docker instead of native env you need to run the pre-commit checks in docker too:

docker exec -i pttbackend_devel /bin/bash -c "pre-commit install"docker exec -i pttbackend_devel /bin/bash -c "pre-commit run --all-files"

You need to have the container running, see above. Or alternatively use the docker run syntax but usingthe running container is faster:

docker run --rm -it -v `pwd`":/app" pttbackend:devel_shell -c "pre-commit run --all-files"

You can use the devel shell to run py.test when doing development, for CI usethe "tox" target in the Dockerfile:

docker build --ssh default --target tox -t pttbackend:tox .docker run --rm -it -v `pwd`":/app" `echo $DOCKER_SSHAGENT` pttbackend:tox

There's a "production" target as well for running the application, remember to change thatarchitecture tag to arm64 if building on ARM:

docker build --ssh default --target production -t pttbackend:amd64-latest .docker run -it --name pttbackend pttbackend:amd64-latest

TLDR:

• Create and activate a Python 3.8 virtualenv (assuming virtualenvwrapper):

  mkvirtualenv -p `which python3.8` my_virtualenv

• change to a branch:

  git checkout -b my_branch

• install Poetry:https://python-poetry.org/docs/#installation

• Install project deps and pre-commit hooks:

  poetry installpre-commit installpre-commit run --all-files

• Ready to go.

Remember to activate your virtualenv whenever working on the repo, this is neededbecause pylint and mypy pre-commit hooks use the "system" python for now (because reasons).