team-folivora / annoto

Medical annotation tool

MIT License

0 stars 1 forks source link

Python scripts #92

Closed n-koenig closed 2 years ago

n-koenig commented 2 years ago

Closes #84

Changes made by this Pull Request

Adds a list of utility scripts for API management similar to 'package.json'

Definition of Done

[x] Tests are written and run successful
[x] User Manual is updated
[x] Code is documented

n-koenig commented 2 years ago

Further ideas:

[x] Move the 3 database scripts from scripts-folder into one script since they each only have one method anyway

codecov-commenter commented 2 years ago

Codecov Report

Merging #92 (36deeb2) into dev (6d2a608) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev      #92   +/-   ##
=======================================
  Coverage   96.07%   96.07%           
=======================================
  Files          18       18           
  Lines         357      357           
=======================================
  Hits          343      343           
  Misses         14       14

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 6d2a608...36deeb2. Read the comment docs.

bewee commented 2 years ago

"This branch has conflicts that must be resolved"

bewee commented 2 years ago

Additional commands we will need for CI & Docker:

[x] db-create (create database, apply all migrations, fill data)
[x] run (python3 -m mod)
[x] typecheck (mypy mod)
[x] api-dump (PYTHON_ENV=production python -m mod.__dumpapi__)

bewee commented 2 years ago

[x] We should ensure that python manage.py install also works when alembic etc are not installed :see_no_evil:

For this: Maybe only import the required scripts in the functions that really use them?

bewee commented 2 years ago

[x] We may want to consider adding a python manage.py install-production that does not install requirements-dev.txt