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.
Drew Short
6aac72bae6
|
5 years ago | |
|---|---|---|
| .. | ||
| documentation | 5 years ago | |
| migrations | 5 years ago | |
| server | 5 years ago | |
| tests | 5 years ago | |
| .dockerignore | 6 years ago | |
| .env | 5 years ago | |
| .gitignore | 5 years ago | |
| .pylintrc | 7 years ago | |
| CHANGELOG.md | 6 years ago | |
| Dockerfile | 5 years ago | |
| LICENSE | 7 years ago | |
| Pipfile | 5 years ago | |
| Pipfile.lock | 5 years ago | |
| README.md | 5 years ago | |
| dev-run.sh | 5 years ago | |
| entrypoint.sh | 5 years ago | |
| manage.py | 5 years ago | |
| mypy.ini | 5 years ago | |
| run_tests.bat | 5 years ago | |
| run_tests.sh | 5 years ago | |
| setup.py | 5 years ago | |
README.md
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