Merge pull request #29 from matagus/misc-fixes-5

Several improvements to pyproject.toml, pre-commit config, README and example project

.github/workflows/ci.yml

@@ -5,6 +5,7 @@ on:
 jobs:
   test:
     strategy:
+      max-parallel: 2
       fail-fast: true
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12"]

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ default_language_version:
 
 repos:
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.2.0"
+    rev: "v0.2.1"
     hooks:
       - id: ruff
         args: [--fix]
@@ -14,8 +14,6 @@ repos:
     hooks:
       - id: black
         args:
-          - "--line-length=120"
-          - "--target-version=py38"
           - "--target-version=py39"
           - "--target-version=py310"
           - "--target-version=py311"

README.md

@@ -3,7 +3,7 @@ django-generic-links
 
 ![Python Compatibility](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue.svg) [![PyPi Version](https://img.shields.io/pypi/v/django-generic-links.svg)](https://pypi.python.org/pypi/django-generic-links)  ![CI badge](https://github.com/matagus/django-generic-links/actions/workflows/ci.yml/badge.svg) [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 
-Simple app to attach links to any Django model. Compatible with Django 4+ and Python 3.9+
+Simple app to attach links to any Django model. Compatible with Django 4.x to 5.0 and Python 3.9 to 3.12.
 
 ![](docs/images/admin.png)
 
@@ -106,7 +106,7 @@ for more information.
 Acknowledgements
 ================
 
-Develop & built using [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+Develop & built using [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![code style - black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 Tools used in building this package:
 

example_project/example_project/settings.py

@@ -39,6 +39,7 @@
     "django.contrib.staticfiles",
     "music_app",
     "generic_links",
+    "django_extensions",
 ]
 
 MIDDLEWARE = [

example_project/music_app/admin.py

@@ -1,7 +1,6 @@
 from django.contrib import admin
 
 from generic_links.admin import GenericLinkStackedInline
-
 from music_app.models import Album, Artist
 
 

example_project/music_app/models.py

@@ -9,7 +9,7 @@ class Artist(models.Model):
     updated_at = models.DateTimeField(auto_now=True)
 
     def __str__(self):
-        return self.name
+        return f"{self.name}"
 
 
 class Album(models.Model):

generic_links/migrations/0001_initial.py

@@ -1,8 +1,7 @@
 from __future__ import annotations
 
 from django.conf import settings
-from django.db import migrations
-from django.db import models
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
@@ -36,7 +35,9 @@ class Migration(migrations.Migration):
                 ("is_external", models.BooleanField(default=True, db_index=True)),
                 (
                     "content_type",
-                    models.ForeignKey(to="contenttypes.ContentType", on_delete=models.CASCADE),
+                    models.ForeignKey(
+                        to="contenttypes.ContentType", on_delete=models.CASCADE
+                    ),
                 ),
                 (
                     "user",

generic_links/templatetags/generic_links_tags.py

@@ -5,12 +5,10 @@
 from __future__ import annotations
 
 from django import template
-from django.db.models import Model
-from django.db.models import QuerySet
+from django.db.models import Model, QuerySet
 
 from generic_links import utils
 
-
 register = template.Library()
 
 

pyproject.toml

@@ -16,6 +16,8 @@ keywords = [
 ]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Environment :: Web Environment",
     "Framework :: Django",
     "Framework :: Django :: 4.0",
     "Framework :: Django :: 4.1",
@@ -29,6 +31,8 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
     "Topic :: Software Development :: Libraries",
 ]
 dependencies = [
@@ -57,9 +61,13 @@ include = [
 
 [tool.hatch.envs.default]
 dependencies = [
-    "Django>=4.0", "ipython", "ipdb", "mypy", "typing-extensions",
+    "Django>=4.0", "ipython", "ipdb", "mypy", "typing-extensions", "django-extensions", "Werkzeug"
 ]
 
+[tool.hatch.envs.default.scripts]
+runserver = "python example_project/manage.py runserver_plus"
+shell = "python example_project/manage.py shell_plus"
+
 # Test environment
 [[tool.hatch.envs.test.matrix]]
 django = ["4.0"]
@@ -85,3 +93,10 @@ test = "python -m django test --settings tests.settings"
 test-cov = "coverage run -m django test --settings tests.settings"
 cov-report = ["coverage combine", "coverage report"]
 cov = ["test-cov", "cov-report"]
+test-cov-report = ["test-cov", "cov-report"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.black]
+line-length = 120

tests/test_models.py

@@ -1,10 +1,10 @@
-#!/usr/bin/env python
 """
 test_generic_links
 ------------
 
 Tests for `generic_links` models module.
 """
+
 from __future__ import annotations
 
 from django.test import TestCase

tests/test_templatetags.py

@@ -1,7 +1,6 @@
 from django.contrib.auth.models import User
 from django.contrib.contenttypes.models import ContentType
-from django.template import Context
-from django.template import Template
+from django.template import Context, Template
 from django.test import TestCase
 
 from generic_links.models import GenericLink