maykin-common 0.1.0__tar.gz

maykin_common-0.1.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Maykin Media
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

maykin_common-0.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include *.rst
+include LICENSE
+include maykin_common/py.typed
+recursive-include maykin_common *.html
+recursive-include maykin_common *.css
+recursive-include maykin_common *.txt
+recursive-include maykin_common *.po
+global-exclude __pycache__
+global-exclude *.py[co]

maykin_common-0.1.0/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: maykin-common
+Version: 0.1.0
+Summary: Re-usable utilities for Maykin Django projects, centrally maintained instead of in default-project.
+Author-email: Maykin Media <support@maykinmedia.nl>
+License: Copyright 2025 Maykin Media
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/maykinmedia/django-common
+Project-URL: Documentation, http://maykin-django-common.readthedocs.io/en/latest/
+Project-URL: Bug Tracker, https://github.com/maykinmedia/django-common/issues
+Project-URL: Source Code, https://github.com/maykinmedia/django-common
+Keywords: django,maykin,boilerplate
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: django>=4.2
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-django; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: tox; extra == "tests"
+Requires-Dist: ruff; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Provides-Extra: release
+Requires-Dist: bump-my-version; extra == "release"
+Provides-Extra: pdf
+Requires-Dist: weasyprint; extra == "pdf"
+Provides-Extra: mfa
+Requires-Dist: django-admin-index; extra == "mfa"
+Requires-Dist: maykin-2fa; extra == "mfa"
+Provides-Extra: axes
+Requires-Dist: django-axes; extra == "axes"
+Dynamic: license-file
+
+
+
+Welcome to maykin-common's documentation!
+=================================================
+
+:Version: 0.1.0
+:Source: https://github.com/maykinmedia/django-common
+:Keywords: ``<keywords>``
+:PythonVersion: 3.12
+
+|build-status| |code-quality| |ruff| |coverage| |docs|
+
+|python-versions| |django-versions| |pypi-version|
+
+
+<One liner describing the project>
+
+.. contents::
+
+.. section-numbering::
+
+Features
+========
+
+* ...
+* ...
+
+Installation
+============
+
+Requirements
+------------
+
+* Python 3.12 or above
+* Django 4.2 or newer
+
+
+Install
+-------
+
+.. code-block:: bash
+
+    pip install maykin-common
+
+
+Usage
+=====
+
+<document or refer to docs>
+
+Local development
+=================
+
+To install and develop the library locally, use::
+
+.. code-block:: bash
+
+    pip install -e .[tests,coverage,docs,release]
+
+When running management commands via ``django-admin``, make sure to add the root
+directory to the python path (or use ``python -m django <command>``):
+
+.. code-block:: bash
+
+    export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings
+    django-admin check
+    # or other commands like:
+    # django-admin makemessages -l nl
+
+
+.. |build-status| image:: https://github.com/maykinmedia/django-common/workflows/Run%20CI/badge.svg
+    :alt: Build status
+    :target: https://github.com/maykinmedia/django-common/actions?query=workflow%3A%22Run+CI%22
+
+.. |code-quality| image:: https://github.com/maykinmedia/django-common/workflows/Code%20quality%20checks/badge.svg
+     :alt: Code quality checks
+     :target: https://github.com/maykinmedia/django-common/actions?query=workflow%3A%22Code+quality+checks%22
+
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+
+.. |coverage| image:: https://codecov.io/gh/maykinmedia/django-common/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/maykinmedia/django-common
+    :alt: Coverage status
+
+.. |docs| image:: https://readthedocs.org/projects/django-common/badge/?version=latest
+    :target: https://maykin-django-common.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. |python-versions| image:: https://img.shields.io/pypi/pyversions/django-common.svg
+
+.. |django-versions| image:: https://img.shields.io/pypi/djversions/django-common.svg
+
+.. |pypi-version| image:: https://img.shields.io/pypi/v/django-common.svg
+    :target: https://pypi.org/project/django-common/

maykin_common-0.1.0/README.rst

@@ -0,0 +1,96 @@
+
+
+Welcome to maykin-common's documentation!
+=================================================
+
+:Version: 0.1.0
+:Source: https://github.com/maykinmedia/django-common
+:Keywords: ``<keywords>``
+:PythonVersion: 3.12
+
+|build-status| |code-quality| |ruff| |coverage| |docs|
+
+|python-versions| |django-versions| |pypi-version|
+
+
+<One liner describing the project>
+
+.. contents::
+
+.. section-numbering::
+
+Features
+========
+
+* ...
+* ...
+
+Installation
+============
+
+Requirements
+------------
+
+* Python 3.12 or above
+* Django 4.2 or newer
+
+
+Install
+-------
+
+.. code-block:: bash
+
+    pip install maykin-common
+
+
+Usage
+=====
+
+<document or refer to docs>
+
+Local development
+=================
+
+To install and develop the library locally, use::
+
+.. code-block:: bash
+
+    pip install -e .[tests,coverage,docs,release]
+
+When running management commands via ``django-admin``, make sure to add the root
+directory to the python path (or use ``python -m django <command>``):
+
+.. code-block:: bash
+
+    export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings
+    django-admin check
+    # or other commands like:
+    # django-admin makemessages -l nl
+
+
+.. |build-status| image:: https://github.com/maykinmedia/django-common/workflows/Run%20CI/badge.svg
+    :alt: Build status
+    :target: https://github.com/maykinmedia/django-common/actions?query=workflow%3A%22Run+CI%22
+
+.. |code-quality| image:: https://github.com/maykinmedia/django-common/workflows/Code%20quality%20checks/badge.svg
+     :alt: Code quality checks
+     :target: https://github.com/maykinmedia/django-common/actions?query=workflow%3A%22Code+quality+checks%22
+
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+
+.. |coverage| image:: https://codecov.io/gh/maykinmedia/django-common/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/maykinmedia/django-common
+    :alt: Coverage status
+
+.. |docs| image:: https://readthedocs.org/projects/django-common/badge/?version=latest
+    :target: https://maykin-django-common.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. |python-versions| image:: https://img.shields.io/pypi/pyversions/django-common.svg
+
+.. |django-versions| image:: https://img.shields.io/pypi/djversions/django-common.svg
+
+.. |pypi-version| image:: https://img.shields.io/pypi/v/django-common.svg
+    :target: https://pypi.org/project/django-common/

maykin_common-0.1.0/maykin_common/apps.py

@@ -0,0 +1,9 @@
+from django.apps import AppConfig
+
+
+class MaykinCommonConfig(AppConfig):
+    name = "maykin_common"
+
+    def ready(self):
+        from . import checks  # noqa
+        from . import settings  # noqa

maykin_common-0.1.0/maykin_common/checks.py

@@ -0,0 +1,78 @@
+import os
+
+from django.conf import settings
+from django.core.checks import Error, Warning, register
+from django.forms import ModelForm
+
+
+def get_subclasses(cls):
+    for subclass in cls.__subclasses__():
+        yield from get_subclasses(subclass)
+        yield subclass
+
+
+@register()
+def check_modelform_exclude(app_configs, **kwargs):
+    """
+    Check that ModelForms use Meta.fields instead of Meta.exclude.
+
+    ModelForm.Meta.exclude is dangerous because it doesn't protect against
+    fields that are added later. Explicit white-listing is safer and prevents
+    bugs such as IMA #645.
+
+    This check piggy-backs on all form modules to be imported during Django
+    startup. It won't cover forms that are defined on the fly such as in
+    formset factories.
+    """
+    errors = []
+
+    for form in get_subclasses(ModelForm):
+        # ok, fields is defined
+        if form._meta.fields or getattr(form.Meta, "fields", None):
+            continue
+
+        # no `.fields` defined, so scream loud enough to prevent this
+        errors.append(
+            Error(
+                f"ModelForm {form.__module__}.{form.__name__} with Meta.exclude "
+                "detected, this is a bad practice",
+                hint="Use ModelForm.Meta.fields instead",
+                obj=form,
+                id="maykin.E001",
+            )
+        )
+
+    return errors
+
+
+@register
+def check_missing_init_files(app_configs, **kwargs):
+    """
+    Check that all packages have __init__.py files.
+
+    If they don't, the code will still run, but tests aren't picked up by the
+    test runner, for example.
+    """
+    errors = []
+
+    for dirpath, _, filenames in os.walk(settings.DJANGO_PROJECT_DIR):
+        dirname = os.path.split(dirpath)[1]
+        if dirname == "__pycache__":
+            continue
+
+        if "__init__.py" in filenames:
+            continue
+
+        extensions = [os.path.splitext(fn)[1] for fn in filenames]
+        if ".py" not in extensions:
+            continue
+
+        errors.append(
+            Warning(
+                f"Directory {dirpath} does not contain an `__init__.py` file {dirname}",
+                hint="Consider adding this module to make sure tests are picked up",
+                id="maykin.W001",
+            )
+        )
+
+    return errors

maykin_common-0.1.0/maykin_common/context_processors.py

@@ -0,0 +1,18 @@
+from django.conf import settings as django_settings
+
+
+def settings(request):
+    """ """
+    public_settings = (
+        "GOOGLE_ANALYTICS_ID",
+        "PROJECT_NAME",
+    )
+
+    context = {
+        "settings": {k: getattr(django_settings, k, None) for k in public_settings},
+    }
+
+    if hasattr(django_settings, "SENTRY_CONFIG"):
+        context.update(dsn=django_settings.SENTRY_CONFIG.get("public_dsn", ""))
+
+    return context

maykin_common-0.1.0/maykin_common/django_two_factor_auth.py

@@ -0,0 +1,20 @@
+from django_admin_index.utils import (
+    should_display_dropdown_menu as default_should_display_dropdown_menu,
+)
+
+
+def should_display_dropdown_menu(request) -> bool:
+    """
+    Overrides the default `should_display_dropdown_menu` from `django_admin_index.utils`
+    to:
+    - not display the dropdown in `maykin_2fa` views.
+    - only display the dropdown to verified users.
+    """
+    default = default_should_display_dropdown_menu(request)
+
+    # never display the dropdown in two-factor admin views
+    if request.resolver_match.view_name.startswith("maykin_2fa:"):
+        return False
+
+    # do not display the dropdown until the user is verified.
+    return default and request.user.is_verified()

maykin_common-0.1.0/maykin_common/management/commands/clear_cache.py

@@ -0,0 +1,16 @@
+from django.core.cache import DEFAULT_CACHE_ALIAS, caches
+from django.core.management import BaseCommand
+from django.utils.translation import gettext as _
+
+
+class Command(BaseCommand):
+    help = "Clears the Django cache"
+
+    def add_arguments(self, parser):
+        parser.add_argument("--alias", help=_("Clear given cache only"))
+
+    def handle(self, *args, **options):
+        alias = options["alias"]
+        cache = caches[alias] if alias else caches[DEFAULT_CACHE_ALIAS]
+
+        cache.clear()

maykin_common-0.1.0/maykin_common/migration_operations.py

@@ -0,0 +1,61 @@
+from django.db import migrations, router
+
+RESET_SQL = """
+    SELECT 'SELECT SETVAL(' ||
+       quote_literal(quote_ident(PGT.schemaname) || '.' || quote_ident(S.relname)) ||
+       ', COALESCE(MAX(' ||quote_ident(C.attname)|| '), 1) ) FROM ' ||
+       quote_ident(PGT.schemaname)|| '.'||quote_ident(T.relname)|| ';'
+    FROM pg_class AS S,
+         pg_depend AS D,
+         pg_class AS T,
+         pg_attribute AS C,
+         pg_tables AS PGT
+    WHERE S.relkind = 'S'
+        AND S.oid = D.objid
+        AND D.refobjid = T.oid
+        AND D.refobjid = C.attrelid
+        AND D.refobjsubid = C.attnum
+        AND T.relname = PGT.tablename
+    ORDER BY S.relname;
+    """
+
+
+class ResetSequences(migrations.RunSQL):
+    """
+    Run the reset_sequences SQL.
+
+    Resetting the Postgres sequences makes sure you don't get Integrity Errors
+    when creating objects because of failing unique constraints. This happens
+    when you create records explicitly with PKs, bypassing the database PK
+    generation. Resetting the sequences makes sure the sequences are aware of
+    the used PKs.
+
+    Usage:
+
+        >>> from maykin_common.migration_operations import ResetSequences
+        >>> class Migration(migrations.Migration):
+        ...     dependencies = (...)
+        ...     operations = [
+        ...         ResetSequences(),
+        ...     ]
+    """
+
+    reversible = True
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(None, *args, **kwargs)
+
+    def database_forwards(self, app_label, schema_editor, from_state, to_state) -> None:
+        if router.allow_migrate(
+            schema_editor.connection.alias, app_label, **self.hints
+        ):
+            with schema_editor.connection.cursor() as cursor:
+                cursor.execute(RESET_SQL)
+                rows = cursor.fetchall()
+
+            sql = "\n".join(x[0] for x in rows)
+
+            self._run_sql(schema_editor, sql)
+
+    def database_backwards(self, *args, **kwargs) -> None:
+        pass

maykin_common-0.1.0/maykin_common/mixins.py

@@ -0,0 +1,92 @@
+from time import time
+
+from django.core.cache import caches
+from django.core.exceptions import PermissionDenied
+from django.http import HttpRequest
+
+from axes.helpers import get_client_ip_address
+
+
+class ThrottleMixin:
+    """
+    A very simple throttling implementation with, hopefully, sane defaults.
+
+    You can specifiy the amount of visits (throttle_visits) a view can get,
+    for a specific period (in seconds) throttle_period.
+    """
+
+    # n visits per period (in seconds)
+    throttle_visits = 100
+    throttle_period = 60**2  # in seconds
+    throttle_403 = True
+    throttle_name = "default"
+
+    # get and options should always be fast. By default
+    # do not throttle them.
+    throttle_methods = ["post", "put", "patch", "delete", "head", "trace"]
+
+    request: HttpRequest
+
+    def get_throttle_cache(self):
+        return caches["default"]
+
+    def get_throttle_identifier(self):
+        user = getattr(self, "user_cache", self.request.user)
+        return str(user.id)
+
+    def create_throttle_key(self):
+        """
+        :rtype string Use as key to save the last access
+        """
+
+        return (
+            f"throttling_{self.get_throttle_identifier()}_"
+            f"{self.throttle_name}_{self.get_throttle_window()}"
+        )
+
+    def get_throttle_window(self):
+        """
+        round down to the throttle_period, which is then used to create the key.
+        """
+        current_time = int(time())
+        return current_time - (current_time % self.throttle_period)
+
+    def get_visits_in_window(self):
+        cache = self.get_throttle_cache()
+        key = self.create_throttle_key()
+
+        initial_visits = 1
+        stored = cache.add(key, initial_visits, self.throttle_period)
+        if stored:
+            visits = initial_visits
+        else:
+            try:
+                visits = cache.incr(key)
+            except ValueError:
+                visits = initial_visits
+        return visits
+
+    def should_be_throttled(self):
+        if self.throttle_methods == "all":
+            return True
+        return self.request.method.lower() in self.throttle_methods
+
+    def dispatch(self, request, *args, **kwargs):
+        if self.throttle_403:
+            if (
+                self.should_be_throttled()
+                and self.get_visits_in_window() > self.throttle_visits
+            ):
+                raise PermissionDenied
+
+        return super().dispatch(request, *args, **kwargs)
+
+
+class IPThrottleMixin(ThrottleMixin):
+    """
+    Same behavior as ThrottleMixin except it limits the amount of tries
+    per IP-address a user can access a certain view.
+    """
+
+    def get_throttle_identifier(self):
+        return get_client_ip_address(self.request)

maykin_common-0.1.0/maykin_common/pdf.py

@@ -0,0 +1,120 @@
+"""
+Utilities for PDF rendering from HTML using WeasyPrint.
+
+Note that you need to add https://pypi.org/project/weasyprint/ to your dependencies
+if you want to make use of HTML-to-PDF rendering. This is not included by default as
+it's quite heavy and requires OS-level dependencies.
+
+This module exposes the public function :func:`render_to_pdf` which renders a template
+with a context into a PDF document (bytes output). You can use "external" stylesheets
+in these templates, and they will be resolved through django's staticfiles machinery
+by the custom :class:`UrlFetcher`.
+"""
+
+import logging
+import mimetypes
+from io import BytesIO
+from pathlib import PurePosixPath
+from urllib.parse import urljoin, urlparse
+
+from django.conf import settings
+from django.contrib.staticfiles import finders
+from django.contrib.staticfiles.storage import staticfiles_storage
+from django.core.files.storage import FileSystemStorage, default_storage
+from django.template.loader import render_to_string
+from django.utils.module_loading import import_string
+
+import weasyprint
+
+from maykin_common.settings import get_setting
+
+logger = logging.getLogger(__name__)
+
+__all__ = ["render_to_pdf"]
+
+
+def get_base_url(*args, **kwargs) -> str:
+    """
+    Get the base URL where the project is served.
+    """
+
+    if pdf_base_url_function := get_setting("PDF_BASE_URL_FUNCTION"):
+        return import_string(pdf_base_url_function)(*args, **kwargs)
+
+    raise NotImplementedError("You must implement 'get_base_url'.")
+
+
+class UrlFetcher:
+    """
+    URL fetcher that skips the network for /static/* files.
+    """
+
+    def __init__(self):
+        self.static_url = self._get_fully_qualified_url(settings.STATIC_URL)
+        is_static_local_storage = issubclass(
+            staticfiles_storage.__class__, FileSystemStorage
+        )
+
+        self.media_url = self._get_fully_qualified_url(settings.MEDIA_URL)
+        is_media_local_storage = issubclass(
+            default_storage.__class__, FileSystemStorage
+        )
+
+        self.candidates = (
+            (self.static_url, staticfiles_storage, is_static_local_storage),
+            (self.media_url, default_storage, is_media_local_storage),
+        )
+
+    @staticmethod
+    def _get_fully_qualified_url(setting: str):
+        fully_qualified_url = setting
+        if not urlparse(setting).netloc:
+            fully_qualified_url = urljoin(get_base_url(), setting)
+        return urlparse(fully_qualified_url)
+
+    def __call__(self, url: str) -> dict:
+        orig_url = url
+        parsed_url = urlparse(url)
+
+        candidate = self.get_match_candidate(parsed_url)
+        if candidate is not None:
+            base_url, storage = candidate
+            path = PurePosixPath(parsed_url.path).relative_to(base_url.path)
+
+            absolute_path = None
+            if storage.exists(path):
+                absolute_path = storage.path(path)
+            elif settings.DEBUG and storage is staticfiles_storage:
+                # use finders so that it works in dev too, we already check that it's
+                # using filesystem storage earlier
+                absolute_path = finders.find(str(path))
+
+            if absolute_path is None:
+                logger.error("Could not resolve path '%s'", path)
+                return weasyprint.default_url_fetcher(orig_url)
+
+            content_type, encoding = mimetypes.guess_type(absolute_path)
+            result = dict(
+                mime_type=content_type,
+                encoding=encoding,
+                redirected_url=orig_url,
+                filename=path.parts[-1],
+            )
+            with open(absolute_path, "rb") as f:
+                result["file_obj"] = BytesIO(f.read())
+            return result
+        return weasyprint.default_url_fetcher(orig_url)
+
+
+def render_to_pdf(template_name: str, context: dict) -> tuple[str, bytes]:
+    """
+    Render a (HTML) template to PDF with the given context.
+    """
+    rendered_html = render_to_string(template_name, context=context)
+    html_object = weasyprint.HTML(
+        string=rendered_html,
+        url_fetcher=UrlFetcher(),
+        base_url=get_base_url(),
+    )
+    pdf: bytes = html_object.write_pdf()
+    return rendered_html, pdf

maykin_common-0.1.0/maykin_common/settings.py

@@ -0,0 +1,34 @@
+from django.conf import settings
+
+GOOGLE_ANALYTICS_ID = None
+"""Google analytics id added to the request context"""
+
+
+SHOW_ENVIRONMENT = False
+"""enable or disable the `environment_info` template tag."""
+
+ENVIRONMENT_BACKGROUND_COLOR = "orange"
+"""The background color of the `environment_info` template tag."""
+
+ENVIRONMENT_FOREGROUND_COLOR = "black"
+"""The foreground color of the `environment_info` template tag."""
+
+ENVIRONMENT_LABEL = None
+"""The foreground color of the `environment_info` template tag."""
+
+RELEASE = None
+"""The environment label shown in the `version_info` template tag."""
+
+GIT_SHA = None
+"""The git hash shown in the `version_info` template tag."""
+
+PDF_BASE_URL_FUNCTION = None
+"""
+Function that returns the base url needed to download/resolve custom fonts and/or any
+image URLs included in the document to render.
+"""
+
+
+def get_setting(name: str):
+    default = globals()[name]
+    return getattr(settings, name, default)

maykin_common-0.1.0/maykin_common/static/maykin_common/css/version.css

@@ -0,0 +1,17 @@
+.version {
+  color: var(--body-fg);
+  padding: 0 30px;
+  font-size: smaller;
+  display: flex;
+  flex-direction: column;
+}
+
+.env-info {
+  display: block;
+  align-self: center;
+  padding-inline: 8px;
+  padding-block: 5px;
+  background-color: var(--admin-env-info-background-color, var(--secondary));
+  color: var(--admin-env-info-color, var(--primary-fg));
+  border-radius: 4px;
+}

maykin_common-0.1.0/maykin_common/templates/maykin_common/includes/version_info.html

@@ -0,0 +1,12 @@
+{% load i18n static %}
+<link rel="stylesheet" href="{% static 'css/maykin_common.css' %}">
+<div class="version" title="Git SHA: {{ GIT_SHA|default:'' }}">
+    <span class="version__release">
+        {% blocktrans %}version {{ RELEASE }}{% endblocktrans %}
+    </span>
+    {% if GIT_SHA %}
+        <code class="version__git-hash">
+            {% blocktrans %}GIT SHA: {{ GIT_SHA }}{% endblocktrans %}
+        </code>
+    {% endif %}
+</div>

maykin_common-0.1.0/maykin_common/templatetags/maykin_common.py

@@ -0,0 +1,46 @@
+from typing import Any
+
+from django import template
+from django.utils.html import escape, format_html, mark_safe
+
+from maykin_common.settings import get_setting
+
+register = template.Library()
+
+
+@register.inclusion_tag("maykin_common/includes/version_info.html")
+def show_version_info():
+    """
+    Template that displays version info.
+    """
+    return {
+        "RELEASE": get_setting("RELEASE"),
+        "GIT_SHA": get_setting("GIT_SHA"),
+    }
+
+
+@register.simple_tag(takes_context=True)
+def show_environment_info(context: dict[str, Any]) -> str:
+    """
+    Template that show the current ENVIRONMENT to an authenticated user.
+
+    Returns an empty string if SHOW_ENVIRONMENT is set to `False`
+    """
+    if not get_setting("SHOW_ENVIRONMENT"):
+        return ""
+    if (user := context.get("user")) is None or not user.is_authenticated:
+        return ""
+
+    style_tokens = {
+        "background-color": get_setting("ENVIRONMENT_BACKGROUND_COLOR"),
+        "color": get_setting("ENVIRONMENT_FOREGROUND_COLOR"),
+    }
+    _inline_style_bits = [
+        f"--admin-env-info-{key}: {value}".format(key=key, value=escape(value))
+        for key, value in style_tokens.items()
+    ]
+    return format_html(
+        """<div class="env-info" style="{style}">{label}</div>""",
+        label=get_setting("ENVIRONMENT_LABEL"),
+        style=mark_safe("; ".join(_inline_style_bits)),
+    )

maykin_common-0.1.0/maykin_common/views.py

@@ -0,0 +1,25 @@
+from django import http
+from django.template import TemplateDoesNotExist, loader
+from django.views.decorators.csrf import requires_csrf_token
+from django.views.defaults import ERROR_500_TEMPLATE_NAME
+
+
+@requires_csrf_token
+def server_error(
+    request, template_name=ERROR_500_TEMPLATE_NAME
+) -> http.HttpResponseServerError:
+    """
+    500 error handler.
+    """
+
+    try:
+        template = loader.get_template(template_name)
+    except TemplateDoesNotExist:
+        if template_name != ERROR_500_TEMPLATE_NAME:
+            # Reraise if it's a missing custom template.
+            raise
+        return http.HttpResponseServerError(
+            b"<h1>Server Error (500)</h1>", content_type="text/html"
+        )
+    context = {"request": request}
+    return http.HttpResponseServerError(template.render(context))

maykin_common-0.1.0/maykin_common.egg-info/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: maykin-common
+Version: 0.1.0
+Summary: Re-usable utilities for Maykin Django projects, centrally maintained instead of in default-project.
+Author-email: Maykin Media <support@maykinmedia.nl>
+License: Copyright 2025 Maykin Media
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/maykinmedia/django-common
+Project-URL: Documentation, http://maykin-django-common.readthedocs.io/en/latest/
+Project-URL: Bug Tracker, https://github.com/maykinmedia/django-common/issues
+Project-URL: Source Code, https://github.com/maykinmedia/django-common
+Keywords: django,maykin,boilerplate
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: django>=4.2
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-django; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: tox; extra == "tests"
+Requires-Dist: ruff; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Provides-Extra: release
+Requires-Dist: bump-my-version; extra == "release"
+Provides-Extra: pdf
+Requires-Dist: weasyprint; extra == "pdf"
+Provides-Extra: mfa
+Requires-Dist: django-admin-index; extra == "mfa"
+Requires-Dist: maykin-2fa; extra == "mfa"
+Provides-Extra: axes
+Requires-Dist: django-axes; extra == "axes"
+Dynamic: license-file
+
+
+
+Welcome to maykin-common's documentation!
+=================================================
+
+:Version: 0.1.0
+:Source: https://github.com/maykinmedia/django-common
+:Keywords: ``<keywords>``
+:PythonVersion: 3.12
+
+|build-status| |code-quality| |ruff| |coverage| |docs|
+
+|python-versions| |django-versions| |pypi-version|
+
+
+<One liner describing the project>
+
+.. contents::
+
+.. section-numbering::
+
+Features
+========
+
+* ...
+* ...
+
+Installation
+============
+
+Requirements
+------------
+
+* Python 3.12 or above
+* Django 4.2 or newer
+
+
+Install
+-------
+
+.. code-block:: bash
+
+    pip install maykin-common
+
+
+Usage
+=====
+
+<document or refer to docs>
+
+Local development
+=================
+
+To install and develop the library locally, use::
+
+.. code-block:: bash
+
+    pip install -e .[tests,coverage,docs,release]
+
+When running management commands via ``django-admin``, make sure to add the root
+directory to the python path (or use ``python -m django <command>``):
+
+.. code-block:: bash
+
+    export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings
+    django-admin check
+    # or other commands like:
+    # django-admin makemessages -l nl
+
+
+.. |build-status| image:: https://github.com/maykinmedia/django-common/workflows/Run%20CI/badge.svg
+    :alt: Build status
+    :target: https://github.com/maykinmedia/django-common/actions?query=workflow%3A%22Run+CI%22
+
+.. |code-quality| image:: https://github.com/maykinmedia/django-common/workflows/Code%20quality%20checks/badge.svg
+     :alt: Code quality checks
+     :target: https://github.com/maykinmedia/django-common/actions?query=workflow%3A%22Code+quality+checks%22
+
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+
+.. |coverage| image:: https://codecov.io/gh/maykinmedia/django-common/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/maykinmedia/django-common
+    :alt: Coverage status
+
+.. |docs| image:: https://readthedocs.org/projects/django-common/badge/?version=latest
+    :target: https://maykin-django-common.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. |python-versions| image:: https://img.shields.io/pypi/pyversions/django-common.svg
+
+.. |django-versions| image:: https://img.shields.io/pypi/djversions/django-common.svg
+
+.. |pypi-version| image:: https://img.shields.io/pypi/v/django-common.svg
+    :target: https://pypi.org/project/django-common/

maykin_common-0.1.0/maykin_common.egg-info/SOURCES.txt

@@ -0,0 +1,27 @@
+LICENSE
+MANIFEST.in
+README.rst
+pyproject.toml
+maykin_common/__init__.py
+maykin_common/apps.py
+maykin_common/checks.py
+maykin_common/context_processors.py
+maykin_common/django_two_factor_auth.py
+maykin_common/migration_operations.py
+maykin_common/mixins.py
+maykin_common/pdf.py
+maykin_common/py.typed
+maykin_common/settings.py
+maykin_common/views.py
+maykin_common.egg-info/PKG-INFO
+maykin_common.egg-info/SOURCES.txt
+maykin_common.egg-info/dependency_links.txt
+maykin_common.egg-info/requires.txt
+maykin_common.egg-info/top_level.txt
+maykin_common/management/__init__.py
+maykin_common/management/commands/__init__.py
+maykin_common/management/commands/clear_cache.py
+maykin_common/static/maykin_common/css/version.css
+maykin_common/templates/maykin_common/includes/version_info.html
+maykin_common/templatetags/__init__.py
+maykin_common/templatetags/maykin_common.py

maykin_common-0.1.0/maykin_common.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

maykin_common-0.1.0/maykin_common.egg-info/requires.txt

@@ -0,0 +1,25 @@
+django>=4.2
+
+[axes]
+django-axes
+
+[docs]
+sphinx
+sphinx-rtd-theme
+
+[mfa]
+django-admin-index
+maykin-2fa
+
+[pdf]
+weasyprint
+
+[release]
+bump-my-version
+
+[tests]
+pytest
+pytest-django
+pytest-cov
+tox
+ruff

maykin_common-0.1.0/maykin_common.egg-info/top_level.txt

@@ -0,0 +1 @@
+maykin_common

maykin_common-0.1.0/pyproject.toml

@@ -0,0 +1,137 @@
+[build-system]
+requires = ["setuptools>=61.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "maykin-common"
+version = "0.1.0"
+description = "Re-usable utilities for Maykin Django projects, centrally maintained instead of in default-project."
+authors = [
+    {name = "Maykin Media", email = "support@maykinmedia.nl"}
+]
+readme = "README.rst"
+license = {file = "LICENSE"}
+keywords = ["django", "maykin", "boilerplate"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: Django",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.2",
+    "Intended Audience :: Developers",
+    "Operating System :: Unix",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">=3.12"
+dependencies = [
+    "django>=4.2"
+]
+
+[project.urls]
+Homepage = "https://github.com/maykinmedia/django-common"
+Documentation = "http://maykin-django-common.readthedocs.io/en/latest/"
+"Bug Tracker" = "https://github.com/maykinmedia/django-common/issues"
+"Source Code" = "https://github.com/maykinmedia/django-common"
+
+[project.optional-dependencies]
+tests = [
+    "pytest",
+    "pytest-django",
+    "pytest-cov",
+    "tox",
+    "ruff",
+    # "pyright",
+    # "django-stubs",
+]
+docs = [
+    "sphinx",
+    "sphinx-rtd-theme",
+]
+release = [
+    "bump-my-version",
+]
+pdf = [
+    "weasyprint"
+]
+mfa = [
+    "django-admin-index",
+    "maykin-2fa"
+]
+axes = [
+    "django-axes"
+]
+
+[tool.setuptools.packages.find]
+include = ["maykin_common*"]
+namespaces = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+DJANGO_SETTINGS_MODULE = "testapp.settings"
+
+[tool.bumpversion]
+current_version = "0.1.0"
+files = [
+    {filename = "pyproject.toml"},
+    {filename = "README.rst"},
+    {filename = "docs/conf.py"},
+]
+
+[tool.coverage.run]
+branch = true
+source = ["maykin_common"]
+omit = [
+    # migrations run while django initializes the test db
+    "*/migrations/*",
+]
+
+[tool.coverage.report]
+exclude_also = [
+    "if (typing\\.)?TYPE_CHECKING:",
+    "@(typing\\.)?overload",
+    "class .*\\(.*Protocol.*\\):",
+    "@(abc\\.)?abstractmethod",
+    "raise NotImplementedError",
+    "\\.\\.\\.",
+    "\\bpass$",
+]
+
+[tool.pyright]
+include = [
+    "{{ project_name|lower }}",
+    "testapp",
+    "tests",
+]
+ignore = []
+pythonVersion = "3.12"
+pythonPlatform = "Linux"
+
+[tool.ruff.lint]
+extend-select = [
+    "UP",  # pyupgrade
+    "DJ",  # django
+    "LOG", # logging
+    "G",
+    "I",   # isort
+    "E",   # pycodestyle
+    "F",   # pyflakes
+    "PERF",# perflint
+    "B",   # flake8-bugbear
+]
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+section-order = [
+    "future",
+    "standard-library",
+    "django",
+    "third-party",
+    "first-party",
+    "local-folder",
+]
+
+[tool.ruff.lint.isort.sections]
+"django" = ["django"]

maykin_common-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+