This is the simplest configuration for developers to start with.
- Run
docker-compose run --rm django ./manage.py migrate
- Run
docker-compose run --rm django ./manage.py createsuperuser
and follow the prompts to create your own user. Set your username to your email to ensure parity with how GitHub logins work. - Run
docker-compose run --rm django ./manage.py create_dev_dandiset --owner your.email@email.com
to create a dummy dandiset to start working with.
- Run
docker-compose up
- Access the site, starting at http://localhost:8000/admin/
- When finished, use
Ctrl+C
Occasionally, new package dependencies or schema changes will necessitate maintenance. To non-destructively update your development stack at any time:
- Run
docker-compose pull
- Run
docker-compose build --pull --no-cache
- Run
docker-compose run --rm django ./manage.py migrate
This configuration still uses Docker to run attached services in the background, but allows developers to run Python code on their native system.
- Install Docker and Docker Compose
- Run
docker-compose -f ./docker-compose.yml up -d
- Install Python 3.8
- Install
psycopg2
build prerequisites. Examplepsycopg2
installation on Ubuntu 20.04:
sudo apt install libpq-dev
export PATH=/usr/lib/postgresql/X.Y/bin/:$PATH
pip install psycopg2
- Create and activate a new Python virtualenv
- Run
pip install -e .[dev]
- Run
source ./dev/export-env.sh
- Run
./manage.py migrate
- Run
./manage.py createsuperuser
and follow the prompts to create your own user - Run
./manage.py create_dev_dandiset --owner your.email@email.com
to create a dummy dandiset to start working with.
- Ensure
docker-compose -f ./docker-compose.yml up -d
is still active - Run:
source ./dev/export-env.sh
./manage.py runserver
- Run in a separate terminal:
source ./dev/export-env.sh
celery --app dandiapi.celery worker --loglevel INFO --without-heartbeat
- When finished, run
docker-compose stop
Attached services may be exposed to the host system via alternative ports. Developers who work on multiple software projects concurrently may find this helpful to avoid port conflicts.
To do so, before running any docker-compose
commands, set any of the environment variables:
DOCKER_POSTGRES_PORT
DOCKER_RABBITMQ_PORT
DOCKER_MINIO_PORT
The Django server must be informed about the changes:
- When running the "Develop with Docker" configuration, override the environment variables:
DJANGO_MINIO_STORAGE_MEDIA_URL
, using the port fromDOCKER_MINIO_PORT
.
- When running the "Develop Natively" configuration, override the environment variables:
DJANGO_DATABASE_URL
, using the port fromDOCKER_POSTGRES_PORT
DJANGO_CELERY_BROKER_URL
, using the port fromDOCKER_RABBITMQ_PORT
DJANGO_MINIO_STORAGE_ENDPOINT
, using the port fromDOCKER_MINIO_PORT
Since most of Django's environment variables contain additional content, use the values from
the appropriate dev/.env.docker-compose*
file as a baseline for overrides.
tox is used to execute all tests.
tox is installed automatically with the dev
package extra.
To install the tox pytest dependencies into your environment, run pip install -e .[test]
.
These are useful for IDE autocompletion or if you want to run pytest
directly (not recommended).
When running the "Develop with Docker" configuration, all tox commands must be run as
docker-compose run --rm django tox
; extra arguments may also be appended to this form.
Run tox
to launch the full test suite.
Individual test environments may be selectively run. This also allows additional options to be be added. Useful sub-commands include:
tox -e lint
: Run only the style checkstox -e type
: Run only the type checkstox -e test
: Run only the pytest-driven teststox -e test -- -k test_file
: Run the pytest-driven tests that match the regular expressiontest_file
tox -e test -- --cov=dandiapi
: Generate a test coverage reporttox -e test -- --cov=dandiapi --cov-report=html
: Generate an HTML test coverage report in thehtmlcov
directory
To automatically reformat all code to comply with
some (but not all) of the style checks, run tox -e format
.
Read-only API endpoints (i.e. GET
, HEAD
) do not require any
authentication. All other endpoints require token authentication
to call.
Visit the URL /admin
with a web browser, logging
in with the credentials entered during the createsuperuser
setup step..
Then go to /swagger
and use GET /auth/token
end-point.
In API endpoint calls, add the Authorization
HTTP header with a value of
Token <token_value>
. For example, for a token 1234
, include the header:
Authorization: Token 1234
.