Caluma Service

A collaborative form editing service. See project site for more details.

Installation

Requirements

• docker
• docker-compose

After installing and configuring those requirements, you can download docker-compose.yml and run the following command:

docker-compose up -d --build

You can now access GraphiQL at http://localhost:8000/graphql

Development

Clone

To work on Caluma you first need to clone

git clone https://github.com/projectcaluma/caluma.git
cd caluma

Open Shell

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 caluma bash

Testing

Once you have shelled in docker container as described above you can use common python tooling for formatting, linting, testing etc.

# linting
flake8
# format code
black .
# running tests
pytest
# create migrations
./manage.py makemigrations

Install new requirements

In case you needed to add new requirements you simply need to build the docker container again for those to be installed and re-open shell.

docker-compose build --pull

Setup pre commit

Pre commit hooks is an additional option instead of executing checks in your editor of choice.

# create virtualenv with tool of your choice
pip install pre-commit
pip install -r requiements-dev.txt -U
pre-commit install

License

Code released under the MIT license.