29 Directory Refactor

[CAGalbraith]

Description

• Closes #29 - Refactors the repo in line with TT standard.
• Closes #30 - because of the refactor there were far too many merge conflicts so it was quicker to implement the changes @ClemAtt made manually.
• Merges PR #33 and PR #35 manually due to the above.

Has This Been Tested?

• [x] Yes

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Checklist:

• [ ] I have performed a self-review of my own code
• [ ] I have made corresponding changes to the documentation
• [ ] I have added tests that prove my fix is effective or that my feature works
• [ ] I have checked my code and corrected any misspellings

[CAGalbraith]

Why would mypy pass locally but fail on the CI?

[ClemAtt]

Try using ‘make pre-commit’ if not already. On 9 Sep 2024 at 19:00 +0100, Connor Galbraith @.***>, wrote:

Why would mypy pass locally but fail on the CI? — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: @.***>

[CAGalbraith]

Still passing locally, hmm

[ClemAtt]

Still passing locally, hmm

Looks like dependency issues. Try adding the stubs for mypy libraries and making sure the poetry toml and .lock are up to date:

gc_registry/client/authentication.py:81: error: Module has no attribute "UTC"  [attr-defined]
gc_registry/client/authentication.py:83: error: Module has no attribute "UTC"  [attr-defined]
gc_registry/client/authentication.py:117: error: Module has no attribute "UTC"  [attr-defined]
gc_registry/main.py:6: error: Library stubs not installed for "markdown"  [import-untyped]
gc_registry/main.py:6: note: Hint: "python3 -m pip install types-Markdown"
gc_registry/main.py:6: note: (or run "mypy --install-types" to install all missing stub packages)
gc_registry/main.py:6: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
Found 4 errors in 2 files (checked 41 source files)
make: *** [Makefile:[21](https://github.com/Future-Energy-Associates/granular_certificate_registry/actions/runs/10778562498/job/29890169421?pr=36#step:6:22): typecheck] Error 1

[ClemAtt]

For schemas vs models the distinction we are using in Tariff Tribe is that:

• schemas: Data Transfer Objects that the API uses to define request objects for validation
• models: Classes that are used to define db definitions

Is this what you were thinking for this? Based on the above definition schemas inherit from BaseModel and models inherit from SQLModel. It seems using BaseModel has less overhead than using SQLModel, so we may want to refactor depending on how we are defining the above. Let's create another ticket for this as required.

Where you following a particular DDD approach for top level structure using client, CRUD, models, schemas? Just so I can understand the logic of the approach. I would have expected the CRUD directory to include methods for interacting with the DB rather than API routes.

[CAGalbraith]

For schemas vs models the distinction we are using in Tariff Tribe is that:

Not sure why I didn't look through the layout of TT beforehand but I like that approach a lot more - it's still a little rough around the edges and I think there are some more changes that can be made between models and schemas, as well as adding enums in the core directory, but otherwise pretty happy with this approach.