refactor(core) Make TRAM an installable package #155
Conversation
This looks like a big commit, but its actually one main change and a bunch of small changes to support that main change. * add setup.cfg so that TRAM can be installed as a package. Now TRAM doesn't need to be manually added to PYTHONPATH, and also `python src/tram/manage.py` is now aliased to `tram` so you can do things like `tram runserver`. * Update documentation and build artifacts to use `tram ...` shortcut instead of `python src/tram/manage.py ...` * Move src/tram/tram/* to src/tram/*. This large rename causes the bulk of what you see in this commit, but I think its a cleaner layout, it's what developers will expect when they check out the project for the first time, and its a more natural fit for an installable package to be laid out this way.
Codecov Report
@@ Coverage Diff @@
## master #155 +/- ##
=======================================
Coverage 95.63% 95.63%
=======================================
Files 9 9
Lines 848 848
=======================================
Hits 811 811
Misses 37 37
Continue to review full report at Codecov.
|
* Fix Sonar Cloud warnings. * Test/fix docker build.
* Fix Docker lint errors * Attempt to fix the black/flake8 lint errors that occur only in CI and not in local. The linters should be ignoring migrations.
|
@m3mike The super linter is throwing errors for the Django migrations, but pyproject.toml is supposed to ignore the migrations. Have you seen this before? |
Yes I have, and yes it's annoying. If I remember right, since from a git perspective the file was changed, the file gets included in a changeset passed directly to the linters. And when a file list is presented to the linters, it can override the ignore regex. I'll add a suggestion thing to the ci check that should fix it. |
I was wondering if that was the issue, and I noticed this config |
* Using M3's suggestion to exclude migrations from super linter.
Actually never tried that for this case but it could work, typically just ended up overriding the merge block on github and documented why in these cases. If you did go that route, you'd probably want to switch it back for normal use, though there isn't that much code so it might not increase CI time too much. |
|
Kudos, SonarCloud Quality Gate passed!
|
|
|
mehaase
changed the title
This looks like a big commit, but its actually one main change and a bunch of small changes to support that main change.
python src/tram/manage.pyis now aliased totramso you can do things liketram runserver.tram ...shortcut instead ofpython src/tram/manage.py ...Setting this as WIP until we can discuss in the tech lead group.
closes #16