neutrons / live_data_server

Data server for data plots

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

live_data_server

Data server for data plots

Contributing

Create a conda environment livedata, containing all the dependencies

conda env create -f environment.yml
conda activate livedata

Containerization

To deploy this application locally for development you will need to assign values to the following secrets as environment variables defined in the shell's environment:

      DATABASE_NAME
      DATABASE_USER
      DATABASE_PASS
      DATABASE_HOST
      DATABASE_PORT
      LIVE_PLOT_SECRET_KEY

It is recommended to save these variables into an .envrc file which can be managed by envdir.

After the secrets are set, type in the terminal shell:

make local/docker/up

This command will copy config/docker-compose.envlocal.yml into docker-compose.yml before composing all the services.

Type make help to learn about other macros available as make targets. For instance, make docker/pruneall will stop all containers, then remove all containers, images, networks, and volumes.

Test & Verification

After starting the services with make local/docker/up, run the test that will post and get data:

DJANGO_SUPERUSER_USERNAME=***** DJANGO_SUPERUSER_PASSWORD=***** pytest tests/test_post_get.py

Environment variables DJANGO_SUPERUSER_USERNAME and DJANGO_SUPERUSER_PASSWORD are defined in file docker-compose.envlocal.yml. You need to either pass these variables with the correct values or have them exported to the shell where pytest is to be run.

Deployment to the Test Environment

About

Data server for data plots

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:HTML 51.8%Language:Python 42.3%Language:Makefile 2.7%Language:Shell 2.5%Language:Dockerfile 0.7%