The Data Donation Platform (DDP) of DataSkop, developed by AlgorithmWatch.
This project was initially bootstrapped with Django-Cookie-Cutter but heavily modified.
Get the code and create .ENV files for local development.
git clone [email protected]:algorithmwatch/dataskop-platform.git
cd dataskop-platform
cp -r docs/exampleenv .envsAdjust .envs/.local to you needs.
See docs/exampleenv.
For consistent code formating, we provide a format script. Since git hooks are not stored with git, you have to configure it on your local machine.
Set up a pre-commit git hook in .git/hooks/pre-commit with the following content.
#!/usr/bin/env bash
# If any command fails, exit immediately with that command's exit status
set -xeo pipefail
docker-compose -f docker-compose.local.yml run --rm django ./scripts/check_format.shEnsure the file is executable: chmod +x .git/hooks/pre-commit and the following config is not empty: git config core.hooksPath.
If it's empty, set it like this:
git config core.hooksPath .git/hooksWe recommend to use VS Code with the Docker-based VS Code Development Container. As an alternative, see below on how to use Docker without VS Code.
To start the development server: Open a new terminal and see how /start will get executed automatically to open two dev servers (Django, Wepback).
To run management command, stop the dev servers and run ./manage.py $command, e.g., ./manage.py makemigrations.
If you add a new VS Code extension, you need to remove this named volume docker volume rm dataskop_extensions. (See more)
./manage migrate
./manage createsuperuser
./manage seeddata
/startInstall and use Docker with Docker-Compose. (See more)
Start development setup:
./local.shTo to run management commands:
./local.sh manage migrateTo run the tests, check your test coverage:
coverage run -m pytest
coverage reportTo only run tests:
pytestIn development, we use MailHog as a local SMTP server with a web interface. View sent emails at: http://localhost:8025
We are using Django-Herald to send emails. To preview the generated texts, go to: http://localhost:8000/herald/
To run a celery worker:
cd dataskop
celery -A config.celery_app worker -l info -Q high_priority,low_priority,celeryPlease note: For Celery's import magic to work, it is important where the celery commands are run. If you are in the same folder with manage.py, you should be right.
See docs/exampleenv/.production/.django. Also the cookiecutter docs may help for some settings.
Docker-Compose (originating from Django-Cookie-Cutter)
Setup Sentry to monitor errors.
Set the SENTRY_DSN as environment variable.
Right now, we only support Mailjet but we could make any other email service from django-anymail work.
Affero General Public License 3.0