warricksothr
/
Corvus
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
A multipurpose python flask API server and administration SPA
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.
35 Commits
3 Branches
0 Tags
251 KiB
 
 
 
 
 
 
Tree: 6aac72bae6
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '6aac72bae6'
${ noResults }
Corvus/server
Drew Short 6aac72bae6
Adding documentation and cleanup of tests 		6 years ago
..
documentation Rename references from corvus to server 6 years ago
migrations Refactor: Add some notes to the README.md 6 years ago
server Adding documentation and cleanup of tests 6 years ago
tests Adding documentation and cleanup of tests 6 years ago
.dockerignore Migrating latest Atheneum changes to Corvus 7 years ago
.env Rename references from corvus to server 6 years ago
.gitignore Refactor: Improve testing 6 years ago
.pylintrc Updating with pylint and pydocstyle testing 7 years ago
CHANGELOG.md Migrating latest Atheneum changes to Corvus 7 years ago
Dockerfile Rename references from corvus to server 6 years ago
LICENSE Update with latest Atheneum patches 7 years ago
Pipfile Refactor: Improve testing 6 years ago
Pipfile.lock Refactor: Improve testing 6 years ago
README.md Adding documentation and cleanup of tests 6 years ago
dev-run.sh Rename references from corvus to server 6 years ago
entrypoint.sh Rename references from corvus to server 6 years ago
manage.py Rename references from corvus to server 6 years ago
mypy.ini Refactor: Appease the pylint rules for the repository 6 years ago
run_tests.bat Rename references from corvus to server 6 years ago
run_tests.sh Rename references from corvus to server 6 years ago
setup.py Rename references from corvus to server 6 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