Move Django-related code into a top-level `src` folder

ddabble commented 1 year ago

Proposed changes

Moved most Django-related code into a new top-level src folder; see the commit messages of ecd3bd9b0eba53cbabf7ae4c61a5c6b6b415d027 and 04230ed2cde4819ee47e05bdcbd16b745d0326b5.

This resolves #601.

DEVELOPERS: Refer to the new "PyCharm" section in the README (click "Click to expand" under the "Setup" section to make it visible) for instructions on which PyCharm settings need to be set to accommodate this new setup.

Also:

Updated manage.py from Django's template (627ff868a6677caffba5c286734ecf04a63a2fe0)
Removed a couple ignore patterns from codecov.yml (8e57a73ba303a23a24ecf21ab7e10ad5b14471ab)
Some minor code/docs improvements (9643d23742537e32b57839835a86823313524b61)

Areas to review closely

That everything works like before, including the management commands.

Deployment notes

Move any web/local_settings.py or web/local_settings_post.py files to src/web/
Delete leftover empty top-level app folders
Uninstall the python-dataporten-auth package (see the commit message of 04230ed2cde4819ee47e05bdcbd16b745d0326b5)
Set Environment="PYTHONPATH=src" in the service config for the website

Checklist

(If any of the points are not relevant, mark them as checked)

[x] Created tests that fail without the changes, if relevant/possible
[x] Made sure that your code conforms to the code style guides and that any common code smells have been addressed
- (It's not intended that you read through this whole document, but that you get yourself an overview over its contents, and that you keep it in mind while taking a second look at your code before opening a pull request)
[x] Added sufficient documentation - e.g. as docstrings or in the README, if suitable
[x] Added your changes to the "Unreleased" section of the changelog - mainly the changes that are of particular interest to users and/or developers, if any
[x] Added a "Deployment notes" section above, if anything out of the ordinary should be done when deploying these changes to the server

codecov[bot] commented 1 year ago

Codecov Report

Merging #614 (9643d23) into dev (010867d) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev     #614   +/-   ##
=======================================
  Coverage   87.70%   87.70%           
=======================================
  Files         134      134           
  Lines        5644     5644           
=======================================
  Hits         4950     4950           
  Misses        694      694

Impacted Files	Coverage Δ
src/announcements/admin.py	`100.00% <ø> (ø)`
src/announcements/forms.py	`100.00% <ø> (ø)`
src/announcements/models.py	`93.93% <ø> (ø)`
...rc/announcements/templatetags/announcement_tags.py	`100.00% <ø> (ø)`
src/announcements/urls.py	`100.00% <ø> (ø)`
src/announcements/views.py	`100.00% <ø> (ø)`
src/card/formfields.py	`93.33% <ø> (ø)`
src/card/modelfields.py	`100.00% <ø> (ø)`
src/card/utils.py	`46.15% <ø> (ø)`
src/card/validators.py	`100.00% <ø> (ø)`
... and 52 more

... and 144 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

ddabble commented 1 year ago

Merging without explicit approval from another member, as the Dev committee agreed to merge these changes and assume they're relatively bug-free, simply to get things done quicker.

MAKENTNU / web