Refactor for CI of tests/linting and Geodjango

Living-with-machines / lwmdb

A django-based library for managing the Living with Machines newspapers metadata database schema

https://living-with-machines.github.io/lwmdb/

MIT License

2 stars 0 forks source link

Refactor for CI of tests/linting and Geodjango #69

Closed griff-rees closed 1 year ago

griff-rees commented 1 year ago

Quite a lot in this merge, some details:

A major refactor to the root folder to avoid significant issues with pre-commit CI
Tests within gazatteer.tests and newspapers.tests modules
pre-commit configuration in .pre-commit-config.yaml
Most of the configuration for CI within pyproject.toml
CI runs runs within .github/workflows/django-docker-test.yml
Shifting to python 3.10^
Possible need to rebuild current docker containers to reflect the shift to python 3.10
The gis.model.Point field coordinates field within the gazatteer.Item class to support spatial queries

kallewesterling commented 1 year ago

Wowza! GREAT WORK!

griff-rees commented 1 year ago

Thanks @kallewesterling: it's mostly just wrapped around your incredibly detailed work ;)

griff-rees commented 1 year ago

Would probably close #64, #65 and #66 at least...

kallewesterling commented 1 year ago

Would probably close #64, #65 and #66 at least...

Couldn't imagine better news on a Friday afternoon!!!

kallewesterling commented 1 year ago

What's the reason for Python 3.10+? I agree with it, but want to know - because I also know there are plenty of folks on the LwM team running way lesser versions.

I think this PR looks great, let's go ahead and pull it @griff-rees ! You do the honors since you've worked so hard on this :)

griff-rees commented 1 year ago

Very good question re Python version. I'm a bit hazy on that decision to be honest. I think it was a dependency problem that I'd solved locally outside docker (I think related to GDAL: note the line in pyproject.toml that specifies a version for anyone on Darwin) and then realised I'd need to enforce that everywhere for consistency, including the dependencies specified in poetry.lock.

In theory because we now have a docker deploy, it's agnostic to what versions people have installed locally but of course if they want to run stuff outside docker that could be tricky if they don't have Python 3.10. But... they would also need to have gis extensions enabled if, for example, they'd rather use SQLite (SpatiaLite) and would need to alter the config for that as well so... I think for the initial release it's easiest to stick with this. Very good question though, wish I'd documented that decision.

kallewesterling commented 1 year ago

Yeah, it's fine. Just wanted to check.. And I think you're right - the containerised version should be fine and enough for folks on the project, for sure.