[TASK] Add linting/black/isort/pytest

krukas · krukas · commit a712537ad87c · 2022-03-04T15:09:42.000+01:00
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ "3.6", "3.7", "3.8", "3.9" ]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: make setup
+      - name: Test
+        run: make test  ARGS="--cov-report term"
+      - name: Upload Coverage to Codecov
+        uses: codecov/codecov-action@v1
diff --git a/.gitignore b/.gitignore
@@ -6,4 +6,7 @@ env/
 *.sqlite3
 build/
 dist/
-*.egg-info
+*.egg-info
+.coverage
+coverage.xml
+htmlcov/
diff --git a/Makefile b/Makefile
@@ -0,0 +1,31 @@
+ENV = env
+BIN = $(ENV)/bin
+PYTHON_VERSION = 3
+PYTHON = $(BIN)/python
+CODE_LOCATIONS = django_anonymous test_project manage.py setup.py
+
+clean:
+	rm -rf env
+	rm -rf build
+	rm -rf dist
+	rm -rf *.egg
+	rm -rf *.egg-info
+	find | grep -i ".*\.pyc$$" | xargs -r -L1 rm
+
+venv: clean
+	$(shell which python$(PYTHON_VERSION)) -m venv $(ENV)
+
+setup: venv
+	$(BIN)/pip install -r requirements.txt
+
+fix-codestyle:
+	$(BIN)/black $(CODE_LOCATIONS)
+	$(BIN)/isort $(CODE_LOCATIONS)
+
+lint:
+	$(BIN)/black --check $(CODE_LOCATIONS)
+	$(BIN)/isort --check-only $(CODE_LOCATIONS)
+	$(BIN)/flake8 $(CODE_LOCATIONS)
+
+test: lint
+	$(PYTHON) -X dev -m pytest $(ARGS)
diff --git a/README.md b/README.md
@@ -1,4 +1,10 @@
-# django-anonymous
+# django-anonymous 
+
+[![CI](https://github.com/krukas/django-anonymous/actions/workflows/main.yml/badge.svg)](https://github.com/krukas/django-anonymous/actions/workflows/main.yml)
+[![codecov](https://codecov.io/gh/krukas/django-anonymous/branch/master/graph/badge.svg?token=BPQQ1RVKDJ)](https://codecov.io/gh/krukas/django-anonymous)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![PyPI version](https://badge.fury.io/py/django-anonymous.svg)](https://badge.fury.io/py/django-anonymous)
+
 
 Simple Djanngo module to anonymize production data for safe usage on none production environments.
 
diff --git a/django_anonymous/__init__.py b/django_anonymous/__init__.py
@@ -1,6 +1,6 @@
-from .faker import Faker
 from .anonymizer import Anonymizer
-from. register import register
+from .faker import Faker
+from .register import register
 
 __all__ = [
     "Faker",
diff --git a/django_anonymous/anonymizer.py b/django_anonymous/anonymizer.py
@@ -1,5 +1,3 @@
-
-
 class Anonymizer:
     SELECT_CHUNK_SIZE = 500
     UPDATE_BATCH_SIZE = 100
diff --git a/django_anonymous/faker.py b/django_anonymous/faker.py
@@ -1,5 +1,5 @@
-from django.utils.translation import get_language
 import faker
+from django.utils.translation import get_language
 
 
 class Faker:
diff --git a/django_anonymous/management/commands/anonymize.py b/django_anonymous/management/commands/anonymize.py
@@ -1,5 +1,6 @@
 from django.core.management.base import BaseCommand
-from django_anonymous.register import registered_models, load_anonymizer
+
+from django_anonymous.register import load_anonymizer, registered_models
 
 
 class Command(BaseCommand):
@@ -17,4 +18,6 @@ def handle(self, *args, **options):
                 model_name = model_anonymizer._model._meta.verbose_name.title()
             else:
                 model_name = model_anonymizer._model._meta.verbose_name_plural.title()
-            self.stdout.write(self.style.SUCCESS(f"{total} {model_name} are anonymized"))
+            self.stdout.write(
+                self.style.SUCCESS(f"{total} {model_name} are anonymized")
+            )
diff --git a/django_anonymous/register.py b/django_anonymous/register.py
@@ -1,4 +1,5 @@
 from importlib import import_module
+
 from django.apps import apps
 
 registered_models = {}
@@ -10,15 +11,16 @@ def register(*models):
 
     def _class_wrapper(anonymizer_class):
         if not models:
-            raise ValueError('At least one model must be passed to register.')
+            raise ValueError("At least one model must be passed to register.")
 
         if not issubclass(anonymizer_class, Anonymizer):
-            raise ValueError('Wrapped class must subclass Anonymizer')
+            raise ValueError("Wrapped class must subclass Anonymizer")
 
         for model in models:
             registered_models[model] = anonymizer_class(model)
 
         return anonymizer_class
+
     return _class_wrapper
 
 
@@ -27,6 +29,8 @@ def load_anonymizer():
     for app in apps.get_app_configs():
         for module in ["anonymizer", "anonymous", "anon"]:
             try:
-                import_module('{}.{}'.format(getattr(app.module, '__package__'), module))
+                import_module(
+                    "{}.{}".format(getattr(app.module, "__package__"), module)
+                )
             except ImportError:
                 pass
diff --git a/manage.py b/manage.py
@@ -6,7 +6,7 @@
 
 def main():
     """Run administrative tasks."""
-    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'test_project.settings')
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "test_project.settings")
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:
@@ -18,5 +18,5 @@ def main():
     execute_from_command_line(sys.argv)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,8 @@
+django~=3.2.12
+faker
+black
+isort
+flake8
+pytest
+pytest-django
+pytest-cov
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,16 @@
+[flake8]
+max-line-length = 88
+ignore = W503
+
+[tool:isort]
+profile = black
+known_first_party =
+    django_anonymous
+
+[tool:pytest]
+DJANGO_SETTINGS_MODULE = test_project.settings
+testpaths = test_project django_anonymous
+addopts =
+    --cov=django_anonymous
+    --cov-report html
+    --cov-report xml
diff --git a/setup.py b/setup.py
@@ -1,11 +1,12 @@
 import os
+
 from setuptools import Command, find_packages, setup
 
 from django_anonymous import __version__
 
 
 def readme():
-    with open('README.md') as f:
+    with open("README.md") as f:
         return f.read()
 
 
@@ -43,18 +44,18 @@ def finalize_options(self):
     name="django-anonymous",
     version=__version__,
     packages=find_packages(include=["django_anonymous", "django_anonymous.*"]),
-    python_requires='>=3.6',
+    python_requires=">=3.6",
     install_requires=["Faker"],
     cmdclass={"publish": PublishCommand, "tag": CreateTagCommand},
     # metadata for upload to PyPI
-    description="Simple Djanngo module to anonymize production data for safe usage on none production environments",
+    description="Simple Djanngo module to anonymize production data for safe usage on none production environments",  # noqa E501
     long_description=readme(),
     long_description_content_type="text/markdown",
-    keywords=['Django', 'anonymous', 'anonymize'],
+    keywords=["Django", "anonymous", "anonymize"],
     author="Maikel Martens",
-    author_email='maikel@martens.me',
+    author_email="maikel@martens.me",
     url="https://github.com/krukas/django-anonymous",
-    download_url=f'https://github.com/krukas/django-anonymous/releases/tag/{__version__}',
+    download_url=f"https://github.com/krukas/django-anonymous/releases/tag/{__version__}",  # noqa E501
     license="GPL3",
     platforms=["any"],
     classifiers=[
@@ -66,4 +67,4 @@ def finalize_options(self):
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
     ],
-)
+)
diff --git a/test_project/anon.py b/test_project/anon.py
@@ -1,9 +1,12 @@
 from django_anonymous import Anonymizer, Faker, register
-from .models import Order, Item
+
+from .models import Item, Order
 
 
 @register(Order)
 class OrderAnonymizer(Anonymizer):
+    UPDATE_BATCH_SIZE = 2
+
     first_name = Faker("first_name", unique=True)
     last_name = "Anon"
 
diff --git a/test_project/migrations/0001_initial.py b/test_project/migrations/0001_initial.py
@@ -1,33 +1,55 @@
 # Generated by Django 3.2.12 on 2022-03-03 15:34
 
-from django.db import migrations, models
 import django.db.models.deletion
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
 
     initial = True
 
-    dependencies = [
-    ]
+    dependencies = []
 
     operations = [
         migrations.CreateModel(
-            name='Order',
+            name="Order",
             fields=[
-                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('created_on', models.DateTimeField(auto_now_add=True)),
-                ('first_name', models.CharField(max_length=128)),
-                ('last_name', models.CharField(max_length=128)),
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("created_on", models.DateTimeField(auto_now_add=True)),
+                ("first_name", models.CharField(max_length=128)),
+                ("last_name", models.CharField(max_length=128)),
             ],
         ),
         migrations.CreateModel(
-            name='Item',
+            name="Item",
             fields=[
-                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('description', models.TextField()),
-                ('amount', models.DecimalField(decimal_places=2, max_digits=11)),
-                ('order', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='items', to='test_project.order')),
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("description", models.TextField()),
+                ("amount", models.DecimalField(decimal_places=2, max_digits=11)),
+                (
+                    "order",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="items",
+                        to="test_project.order",
+                    ),
+                ),
             ],
         ),
     ]
diff --git a/test_project/settings.py b/test_project/settings.py
diff --git a/test_project/test_anonymizer.py b/test_project/test_anonymizer.py
diff --git a/test_project/tests.py b/test_project/tests.py

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-`
`2`		`-`
`3`	`1`	`class Anonymizer:`
`4`	`2`	`SELECT_CHUNK_SIZE = 500`
`5`	`3`	`UPDATE_BATCH_SIZE = 100`