You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1.0 KiB
1.0 KiB
Corvus Server
API Documentation
Requirements
- Python 3.6
- Pipenv
Installation
git clone https://gitlab.com/WarrickSothr/Corvus.git
cd Corvus/server
pipenv install
pipenv shell
Configuration
Specify a settings file
export SERVER_SETTINGS='<path to settings python file>'
Running
Docker
docker build -t corvus:local-test .
docker run -d corvus:local-test
Local Development Version
Run a local version
FLASK_APP=corvus:corvus flask db upgrade
python manage.py user register-admin
FLASK_APP=corvus:corvus flask run
Set log level
export SERVER_LOGLEVEL=DEBUG
FAQ
Development
pipenv install --dev
- Make changes
- Add/Update tests
./run_tests
- If everything passes follow contributing guide.
Testing
To run the pytests directly, use the following command
PYTHONPATH=$(pwd) pipenv run py.test
Contributing
See ../CONTRIBUTING.md