Merge pull request #10 from matagus/precommit+django-upgrade

 Added pre-commit with flake8, black, django upgrade and more!

Author: matagus

.gitignore

@@ -9,3 +9,4 @@ django_generic_links.egg-info/
 generic_links.egg-info/
 .tox
 .coverage
+project/

.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+default_language_version:
+  python: python3.10
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: check-added-large-files
+  - id: check-case-conflict
+  - id: check-json
+  - id: check-merge-conflict
+  - id: check-symlinks
+  - id: check-toml
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.3.1
+  hooks:
+  - id: pyupgrade
+    args: [--py38-plus]
+- repo: https://github.com/psf/black
+  rev: 22.12.0
+  hooks:
+  - id: black
+- repo: https://github.com/asottile/blacken-docs
+  rev: v1.12.1
+  hooks:
+  - id: blacken-docs
+    additional_dependencies:
+    - black==22.10.0
+- repo: https://github.com/asottile/reorder_python_imports
+  rev: v3.9.0
+  hooks:
+  - id: reorder-python-imports
+    args:
+    - --py38-plus
+    - --application-directories
+    - .:example:src
+    - --add-import
+    - 'from __future__ import annotations'
+- repo: https://github.com/PyCQA/flake8
+  rev: 6.0.0
+  hooks:
+  - id: flake8
+    additional_dependencies:
+    - flake8-bugbear
+    - flake8-comprehensions
+    - flake8-tidy-imports
+    - flake8-typing-imports

LICENSE

@@ -28,7 +28,3 @@ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
-
-

README.md

@@ -30,10 +30,10 @@ Installing `django-generic-links` is fairly easy. You can...
 then add `generic_links` to your `settings.py`:
 
 ``` python
-    INSTALLED_APPS = (
-        # ...
-        'generic_links',
-    )
+INSTALLED_APPS = (
+    # ...
+    "generic_links",
+)
 ```
 
 and then run the migrations!

generic_links/__init__.py

@@ -1,3 +1,3 @@
-# -*- coding: UTF-8 -*-
+from __future__ import annotations
 
-__version__ = '0.7.1'
+__version__ = "0.8.0"

generic_links/admin.py

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+from __future__ import annotations
+
 from django.contrib import admin
 from django.contrib.contenttypes import admin as ct_admin
 
@@ -18,6 +19,9 @@ class GenericLinkTabularInline(ct_admin.GenericTabularInline):
 @admin.register(GenericLink)
 class GenericLinkAdmin(admin.ModelAdmin):
     list_display = ("title", "url", "description", "created_at", "user", "is_external")
-    search_fields = ('title', 'url', 'user')
-    list_filter = ('is_external', 'created_at', )
-    raw_id_fields = ('user', )
+    search_fields = ("title", "url", "user__username")
+    list_filter = (
+        "is_external",
+        "created_at",
+    )
+    raw_id_fields = ("user",)

generic_links/apps.py

@@ -1,6 +1,7 @@
-# -*- coding: utf-8
+from __future__ import annotations
+
 from django.apps import AppConfig
 
 
 class GenericLinksConfig(AppConfig):
-    name = 'generic_links'
+    name = "generic_links"

generic_links/forms.py

@@ -1,4 +1,5 @@
-# -*- coding: UTF-8 -*-
+from __future__ import annotations
+
 from django import forms
 
 from generic_links.models import GenericLink
@@ -13,13 +14,16 @@ def __init__(self, user, content_type, object_id, *args, **kwargs):
         self.user = user
         self.content_type = content_type
         self.object_id = object_id
-        super(AddLinkForm, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
     def save(self, *args, **kwargs):
         self.instance = GenericLink.objects.create(
-            content_type=self.content_type, object_id=self.object_id,
+            content_type=self.content_type,
+            object_id=self.object_id,
             url=self.cleaned_data["url"].strip(),
-            title=self.cleaned_data["title"], user=self.user,
-            is_external=self.cleaned_data["is_external"])
+            title=self.cleaned_data["title"],
+            user=self.user,
+            is_external=self.cleaned_data["is_external"],
+        )
 
         return self.instance

generic_links/migrations/0001_initial.py

@@ -1,35 +1,59 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
+from __future__ import annotations
 
-from django.db import models, migrations
 from django.conf import settings
+from django.db import migrations
+from django.db import models
 
 
 class Migration(migrations.Migration):
 
     dependencies = [
-        ('contenttypes', '__first__'),
+        ("contenttypes", "__first__"),
         migrations.swappable_dependency(settings.AUTH_USER_MODEL),
     ]
 
     operations = [
         migrations.CreateModel(
-            name='GenericLink',
+            name="GenericLink",
             fields=[
-                ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
-                ('object_id', models.PositiveIntegerField(db_index=True)),
-                ('url', models.URLField()),
-                ('title', models.CharField(max_length=200)),
-                ('description', models.TextField(max_length=1000, null=True, blank=True)),
-                ('created_at', models.DateTimeField(auto_now_add=True, db_index=True)),
-                ('is_external', models.BooleanField(default=True, db_index=True)),
-                ('content_type', models.ForeignKey(to='contenttypes.ContentType', on_delete=models.CASCADE)),
-                ('user', models.ForeignKey(blank=True, to=settings.AUTH_USER_MODEL, null=True, on_delete=models.SET_NULL)),
+                (
+                    "id",
+                    models.AutoField(
+                        verbose_name="ID",
+                        serialize=False,
+                        auto_created=True,
+                        primary_key=True,
+                    ),
+                ),
+                ("object_id", models.PositiveIntegerField(db_index=True)),
+                ("url", models.URLField()),
+                ("title", models.CharField(max_length=200)),
+                (
+                    "description",
+                    models.TextField(max_length=1000, null=True, blank=True),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True, db_index=True)),
+                ("is_external", models.BooleanField(default=True, db_index=True)),
+                (
+                    "content_type",
+                    models.ForeignKey(
+                        to="contenttypes.ContentType", on_delete=models.CASCADE
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        blank=True,
+                        to=settings.AUTH_USER_MODEL,
+                        null=True,
+                        on_delete=models.SET_NULL,
+                    ),
+                ),
             ],
             options={
-                'ordering': ('-created_at',),
-                'verbose_name': 'Generic Link',
-                'verbose_name_plural': 'Generic Links',
+                "ordering": ("-created_at",),
+                "verbose_name": "Generic Link",
+                "verbose_name_plural": "Generic Links",
             },
         ),
     ]

generic_links/models.py

@@ -1,9 +1,10 @@
-# -*- coding: UTF-8 -*-
+from __future__ import annotations
+
 from django.contrib.auth import get_user_model
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.contrib.contenttypes.models import ContentType
 from django.db import models
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 
 
 class GenericLink(models.Model):
@@ -19,14 +20,15 @@ class GenericLink(models.Model):
     title = models.CharField(max_length=200)
     description = models.TextField(max_length=1000, null=True, blank=True)
 
-    user = models.ForeignKey(get_user_model(), null=True, blank=True,
-                             on_delete=models.SET_NULL)
+    user = models.ForeignKey(
+        get_user_model(), null=True, blank=True, on_delete=models.SET_NULL
+    )
     created_at = models.DateTimeField(auto_now_add=True, db_index=True)
 
     is_external = models.BooleanField(default=True, db_index=True)
 
     class Meta:
-        ordering = ("-created_at", )
+        ordering = ("-created_at",)
         verbose_name = _("Generic Link")
         verbose_name_plural = _("Generic Links")