Reorganize and modernize repository

[glass-ships]

Short description of the changes:

• Reorganize repository for clarity and maintanability
• Ensure same functionality

Long description of the changes:

• Do away with confusing double-nesting directory structure, in favor of a common community preferred structure, with top level config/ and apps/ directories:

.
├── deploy-config
│   ├── docker-compose.envlocal.yml
│   └── nginx/
 src
│   ├── apps
│   │   ├── __init__.py
│   │   ├── plots
│   │   │   ├── management/commands/
│   │   │   ├── migrations/
│   │   │   ├── admin.py
│   │   │   ├── apps.py
│   │   │   ├── models.py
│   │   │   ├── tests.py
│   │   │   ├── urls.py
│   │   │   ├── views.py
│   │   │   └── view_util.py
│   ├── config
│   │   ├── settings.py
│   │   ├── urls.py
│   │   └── wsgi.py
│   └── manage.py
├── tests/
...

• Rename top level config/ to deploy-config/ to differentiate from django config
  • This is where a potential postgres/ Dockerfile and configuration could go if we go that route for expanding our database image

Check list for the pull request

• I have read the [CONTRIBUTING]
• I have read the [CODE_OF_CONDUCT]
• I have added tests for my changes
• I have updated the documentation accordingly

Check list for the reviewer

• I have read the [CONTRIBUTING]
• I have verified the proposed changes
• best software practices
  • all internal functions have an underbar, as is python standard
  • clearly named variables (better to be verbose in variable names)
  • code comments explaining the intent of code blocks
• All the tests are passing
• The documentation is up to date
• code comments added when explaining intent

Manual test for the reviewer

References

[glass-ships]

Not sure why test action is failing now...
Tests pass, but coverage step fails with:

  cd /tmp/app
  coverage combine
  coverage xml
  cp coverage.xml $OLDPWD
  coverage report
Combined data file .coverage.d2f16c961895.22.XrRTDrTx
Skipping duplicate data .coverage.d2f16c961895.23.XTEaVhAx
Skipping duplicate data .coverage.d2f16c961895.24.XkGYryOx
No data to report.
Error: Process completed with exit code 1.

[glass-ships]

@rosswhitfield sorry to ping again.
would you happen to have any ideas as to why these changes would break the coverage part of things / what i could try to fix it?

[rosswhitfield]

You need to update .coveragerc to source=apps,config

[glass-ships]

aha, that did it. thanks ross!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.75%. Comparing base (25a1c73) to head (beb077b).
Report is 7 commits behind head on next.

Additional details and impacted files

@@           Coverage Diff           @@
##             next      #29   +/-   ##
=======================================
  Coverage   86.75%   86.75%           
=======================================
  Files          12       12           
  Lines         317      317           
=======================================
  Hits          275      275           
  Misses         42       42           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jmborr]

The local deployment works, the rest looks 👌