Projectsetup (#6)

* Make project compatible with pip and buildout.

Add optional extras for running tests and development.

* lint

* try to fix build

* fix build?

* wop

* install test dependencies

* allow old python

.github/workflows/tests.yml

@@ -28,11 +28,17 @@ jobs:
 
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip poetry
+        python -m pip install --upgrade pip
+        pip install .[test]
         poetry install --all-extras --no-root
 
+    - name: Check code quality
+      run: |
+        poetry run black --check oscar_odin/
+        poetry run pylint oscar_odin/
+
     - name: Test with Django test runner
       run: |
-        poetry run coverage run --branch -- ./runtests.py
+        poetry run coverage run --branch -- ./manage.py test
         poetry run coverage xml --include="oscar_odin/*" -o dist/coverage.xml 
         poetry run coverage report --include="oscar_odin/*"

.pre-commit-config.yaml

@@ -1,35 +1,23 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 default_language_version:
-    python: python3.8
+    python: python3.10
+
 
 repos:
--   repo: https://github.com/asottile/pyupgrade
-    rev: v3.3.1
-    hooks:
-    -   id: pyupgrade
-        args:
-        - --py38-plus
-        - --keep-runtime-typing
--   repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.270
-    hooks:
-    -   id: ruff
-        args:
-        - --fix
-        - --exit-non-zero-on-fix
--   repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-    -   id: isort
-        name: isort (python)
-    -   id: isort
-        name: isort (cython)
-        types: [cython]
-    -   id: isort
-        name: isort (pyi)
-        types: [pyi]
--   repo: https://github.com/psf/black
-    rev: 23.1.0
-    hooks:
-    -   id: black
+- repo: local
+  hooks:
+    - id: black
+      name: black
+      language: system
+      types: [python]
+      entry: black
+      args: [--check, oscar_odin/]
+      pass_filenames: false
+    - id: pylint
+      name: pylint
+      entry: pylint
+      args: [oscar_odin/]
+      language: system
+      types: [python]
+      pass_filenames: false

Makefile

@@ -1,4 +1,4 @@
-.PHONY: fail-if-no-virtualenv all install lint test black
+.PHONY: fail-if-no-virtualenv all install dev lint test black
 
 all: install migrate loaddata collectstatic
 
@@ -14,16 +14,19 @@ PIP_INDEX_URL=https://pypi.org/simple
 endif
 
 
+dev: install
+	pip install .[dev]
+
 install: fail-if-no-virtualenv
-	pip install poetry
-	poetry install
+	pip install .[test]
 
 lint: fail-if-no-virtualenv
-	black --check  oscar_odin/**/*.py
+	black --check oscar_odin/
 	pylint oscar_odin/
 
 test: fail-if-no-virtualenv
-	python3 runtests.py test tests.reverse.test_catalogue
+	python3 manage.py makemigrations --check --dry-run
+	@python3 manage.py test tests/
 
 black:
 	@black oscar_odin/
@@ -32,5 +35,5 @@ black:
 ill:
 	rm db.sqlite3
 	cp klaas.sqlite3 db.sqlite3
-	python3 runtests.py migrate
-	python3 runtests.py test_illshit
+	python3 manage.py migrate
+	python3 manage.py test_illshit

README.md

@@ -19,7 +19,14 @@ product = Product.objects.get(id=1)
 product_resource = catalogue.product_to_resource(product)
 ```
 
-# run tests
+# Developing odin
+
+## Using pip:
 
 make install
-make tests
+make test
+
+## Using poetry:
+
+poetry install --all-extras
+poetry run ./manage.py test

runtests.py → manage.py

@@ -4,7 +4,7 @@
 
 import django
 from django.conf import settings
-from django.test.utils import get_runner
+
 
 if __name__ == "__main__":
     # Configure path and django settings module

noxfile.py

@@ -17,4 +17,4 @@ def tests(session: Session):
     )
     # fmt: on
     session.install("-Ur", "requirements.txt")
-    session.run(HERE / "runtests.py")
+    session.run(HERE / "manage.py")

oscar_odin/django_resolver.py

@@ -11,6 +11,7 @@
 class ModelFieldResolver(FieldResolverBase):
     """Field resolver for Django models."""
 
+    # pylint: disable=protected-access
     def get_field_dict(self) -> Dict[str, Optional[Field]]:
         """Get a dictionary of fields from the source object."""
         meta = getmeta(self.obj)

oscar_odin/management/commands/test_illshit.py

@@ -1,11 +1,11 @@
+# pylint: disable=W0611
 import io
 import PIL
 
 from decimal import Decimal as D
 
 from django.core.management.base import BaseCommand
 from django.core.files import File
-from django.test import TestCase
 from oscar.core.loading import get_model
 
 from oscar_odin.mappings.catalogue import products_to_db

oscar_odin/resources/catalogue.py

@@ -7,7 +7,6 @@
 from oscar.core.loading import get_model
 
 import odin
-from odin.annotated_resource.type_aliases import Url
 
 from ..fields import DecimalField
 from ._base import OscarResource

oscar_odin/utils.py

@@ -4,7 +4,6 @@
 
 from django.db import connection, reset_queries
 
-from typing import Any, Tuple, NamedTuple
 from collections import defaultdict
 
 from django.db.models import Model, ManyToManyField, ForeignKey, Q