django-logger-extra 1.0.0__tar.gz

django_logger_extra-1.0.0/.commitlintrc.mjs

@@ -0,0 +1,43 @@
+export default {
+  extends: [
+    '@commitlint/config-conventional'
+  ],
+  ignores: [
+    (message) => message.includes('Signed-off-by: dependabot[bot]'),
+    (message) => message.includes('Signed-off-by: sol-office-file-synchronization[bot]')
+  ],
+  rules: {
+    'header-max-length': [
+      2,
+      'always',
+      72
+    ],
+    'body-max-line-length': [
+      2,
+      'always',
+      72
+    ],
+    'body-leading-blank': [
+      2,
+      'always'
+    ],
+    'type-enum': [
+      2,
+      'always',
+      [
+        'build',
+        'chore',
+        'ci',
+        'deps',
+        'docs',
+        'feat',
+        'fix',
+        'perf',
+        'refactor',
+        'revert',
+        'style',
+        'test'
+      ]
+    ]
+  }
+};

django_logger_extra-1.0.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    commit-message:
+      prefix: "deps"
+    # Disable version updates and only allow security updates
+    open-pull-requests-limit: 0

django_logger_extra-1.0.0/.github/workflows/pre-commit.yml

@@ -0,0 +1,27 @@
+name: Run pre-commit hooks
+
+env:
+  DEFAULT_PYTHON: "3.10"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  pre-commit:
+    name: Run pre-commit hooks
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Run pre-commit
+        uses: pre-commit/action@v3.0.1

django_logger_extra-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,56 @@
+name: Create release & publish to PyPI
+# If ran manually, e.g. with ref set to "refs/tags/v1.2.3", set the run name to "Publish refs/tags/v1.2.3".
+run-name: ${{ inputs.ref && format('Publish {0}', inputs.ref) || null }}
+
+on:
+  push:
+    branches:
+      - main
+  # Run daily to keep the release PR date current
+  schedule:
+    - cron: '1 0 * * *'
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: "The branch, tag or SHA to publish."
+        required: true
+        type: string
+
+jobs:
+  release-please:
+    uses: City-of-Helsinki/.github/.github/workflows/release-please.yml@main
+    permissions:
+      contents: write
+      pull-requests: write
+    with:
+        include-component-in-tag: false
+
+  build:
+    needs:
+      - release-please
+    uses: City-of-Helsinki/.github/.github/workflows/build-python-dists.yml@main
+    with:
+        ref: ${{ inputs.ref }}
+    # Run build job if a release was created or a ref was specified (i.e. workflow was invoked manually)
+    if: ${{ needs.release-please.outputs.release_created || inputs.ref }}
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs:
+      - build
+    # Run publish job if an artifact was uploaded
+    if: ${{ needs.build.outputs.artifact_name }}
+    environment:
+      name: pypi
+      url: https://pypi.org/p/django-logger-extra
+    permissions:
+      id-token: write  # mandatory for trusted publishing
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+      with:
+        name: ${{ needs.build.outputs.artifact_name }}
+        path: dist/
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0

django_logger_extra-1.0.0/.github/workflows/test.yml

@@ -0,0 +1,43 @@
+name: Run tests
+
+env:
+  DEFAULT_PYTHON: "3.10"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    name: Python ${{ matrix.python_version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python_version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python_version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python_version }}
+
+    - name: Install hatch
+      run: python -m pip install hatch
+
+    - name: Tests
+      run: hatch test -i py=${{ matrix.python_version }} -- --cov=. --cov-report=xml
+
+    - name: Override coverage report source path for SonarQube Cloud
+      if: ${{ matrix.python_version == env.DEFAULT_PYTHON }}
+      run: sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' coverage.xml
+
+    - name: SonarQube Cloud Scan
+      if: ${{ matrix.python_version == env.DEFAULT_PYTHON }}
+      uses: SonarSource/sonarqube-scan-action@fd88b7d7ccbaefd23d8f36f73b59db7a3d246602 # v6.0.0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

django_logger_extra-1.0.0/.gitignore

@@ -0,0 +1,172 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc
+.DS_Store

django_logger_extra-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,47 @@
+default_language_version:
+  python: python3
+default_install_hook_types: [pre-commit, commit-msg]
+default_stages: [pre-commit, manual]
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+  # Run pyupgrade and django-upgrade before ruff, as these two might alter
+  # the code in a way that requires reformatting.
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.21.0
+    hooks:
+      - id: pyupgrade
+        args: ["--py310-plus"]
+  - repo: https://github.com/adamchainz/django-upgrade
+    rev: "1.29.1"
+    hooks:
+      - id: django-upgrade
+        args: [--target-version, "4.2"]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.2
+    hooks:
+      # Run the linter.
+      - id: ruff-check
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format
+  - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
+    rev: v9.22.0
+    hooks:
+      - id: commitlint
+        stages: [commit-msg, manual]
+        additional_dependencies: ["@commitlint/config-conventional"]
+  - repo: https://github.com/koalaman/shellcheck-precommit
+    rev: v0.11.0
+    hooks:
+      - id: shellcheck
+  - repo: https://github.com/thlorenz/doctoc
+    rev: v2.2.0
+    hooks:
+      - id: doctoc

django_logger_extra-1.0.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.0.0"
+}

django_logger_extra-1.0.0/CHANGELOG.md

@@ -0,0 +1,9 @@
+<!-- DOCTOC SKIP -->
+# Changelog
+
+## [1.0.0](https://github.com/City-of-Helsinki/django-logger-extra/compare/v0.1.0...v1.0.0) (2025-11-13)
+
+
+### Dependencies
+
+* Update python and django version support ([c1eccc4](https://github.com/City-of-Helsinki/django-logger-extra/commit/c1eccc4bf013839c9084da0706ba34a1c208de90))

django_logger_extra-1.0.0/CODEOWNERS

@@ -0,0 +1 @@
+* @City-of-Helsinki/ratkaisutoimiston-backend

django_logger_extra-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 City of Helsinki
+
+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.

django_logger_extra-1.0.0/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.4
+Name: django-logger-extra
+Version: 1.0.0
+Summary: A module that provides extras for logger.
+Project-URL: Homepage, https://github.com/City-of-Helsinki/django-logger-extra
+Project-URL: Issues, https://github.com/City-of-Helsinki/django-logger-extra/issues
+Author-email: City of Helsinki <dev@hel.fi>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: extra tools,logging,plugin extension
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Dist: django>=4.2
+Provides-Extra: all
+Requires-Dist: coverage-enable-subprocess; extra == 'all'
+Requires-Dist: coverage[toml]; extra == 'all'
+Requires-Dist: django-auditlog; extra == 'all'
+Requires-Dist: pytest; extra == 'all'
+Requires-Dist: pytest-cov; extra == 'all'
+Requires-Dist: pytest-django; extra == 'all'
+Requires-Dist: pytest-randomly; extra == 'all'
+Requires-Dist: pytest-rerunfailures; extra == 'all'
+Requires-Dist: pytest-xdist[psutil]; extra == 'all'
+Provides-Extra: auditlog
+Requires-Dist: django-auditlog; extra == 'auditlog'
+Provides-Extra: test
+Requires-Dist: coverage-enable-subprocess; extra == 'test'
+Requires-Dist: coverage[toml]; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest-django; extra == 'test'
+Requires-Dist: pytest-randomly; extra == 'test'
+Requires-Dist: pytest-rerunfailures; extra == 'test'
+Requires-Dist: pytest-xdist[psutil]; extra == 'test'
+Description-Content-Type: text/markdown
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Logger extras for simplified structured logging.](#logger-extras-for-simplified-structured-logging)
+  - [Adding django-logger-extra your Django project](#adding-django-logger-extra-your-django-project)
+    - [Adding django-resilient-logger Django apps](#adding-django-resilient-logger-django-apps)
+    - [Configuring logger formatter in settings.py:](#configuring-logger-formatter-in-settingspy)
+    - [Configuring middleware in settings.py:](#configuring-middleware-in-settingspy)
+  - [django-auditlog extra context.](#django-auditlog-extra-context)
+  - [Logger context usage](#logger-context-usage)
+- [Development](#development)
+  - [Running tests](#running-tests)
+  - [Code format](#code-format)
+  - [Git blame ignore refs](#git-blame-ignore-refs)
+  - [Commit message format](#commit-message-format)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# Logger extras for simplified structured logging.
+
+`django-logger-extra` is a collection of logger extras that makes structured logging setup easier.
+
+## Adding django-logger-extra your Django project
+
+Add `django-logger-extra` in your project's dependencies.
+
+### Adding django-resilient-logger Django apps
+
+To install this logger, add `INSTALLED_APPS` in settings.py:
+
+```python
+INSTALLED_APPS = (
+    'logger_extra',
+    ...
+)
+```
+
+### Configuring logger formatter in settings.py:
+To make use of the JSON formatter it must be configured in setting's LOGGING section.
+Filter is optional and brings `logger_context()` contexts available as logger extras.
+
+```python
+LOGGING = {
+    'filters': {
+        'context': {
+            '()': 'logger_extra.filter.LoggerContextFilter',
+        }
+        ...
+    },
+    'formatters': {
+        'json': {
+            '()': 'logger_extra.formatter.JSONFormatter',
+        }
+        ...
+    },
+    'handlers': {
+        'console': {
+            'class': 'logging.StreamHandler',
+            'formatter': 'json',
+            'filters': ['context']
+        },
+        ...
+    },
+    ...
+}
+```
+
+### Configuring middleware in settings.py:
+```python
+MIDDLEWARE = [
+    'logger_extra.middleware.XRequestIdMiddleware',
+    ...
+]
+```
+
+## django-auditlog extra context.
+This library can also augment django-auditlog's additional_data fields with active context.
+To enable this, optional package `django-auditlog` must be installed and it must be explicitly enabled
+in settings.py file.
+```python
+LOGGER_EXTRA_AUGMENT_DJANGO_AUDITLOG = True
+```
+
+## Logger context usage
+Active context can be appended with `logger_context` function. It will return current
+context as resource. The current context can also be read using function `get_logger_context`.
+```python
+import logging
+from django.http import HttpRequest, JsonResponse
+
+from logger_extra.logger_context import logger_context
+
+logger = logging.getLogger("audit")
+
+def bar():
+  with logger_context({ "who": "World" }) as ctx:
+    logger.info(f"{ctx['greet']} {ctx['who']}")
+
+def foo():
+  with logger_context({ "greet": "Hello" }):
+    bar()
+    return JsonResponse({})
+```
+
+Will result log entry that looks like:
+`{"message": "Hello World", "level": "INFO", "time": "2025-04-14T11:08:22.962222+00:00", "context": {"request_id": "95e787b5-4ce8-46ef-bb6e-31651fc8774b", "greet": "Hello", "who": "World"}}`
+# Development
+
+Virtual Python environment can be used. For example:
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+Install package requirements:
+
+```bash
+pip install -e .
+```
+
+Install development requirements:
+
+```bash
+pip install -r requirements-test.txt
+```
+
+## Running tests
+
+```bash
+pytest
+```
+
+## Code format
+
+This project uses [Ruff](https://docs.astral.sh/ruff/) for code formatting and quality checking.
+
+Basic `ruff` commands:
+
+* lint: `ruff check`
+* apply safe lint fixes: `ruff check --fix`
+* check formatting: `ruff format --check`
+* format: `ruff format`
+
+[`pre-commit`](https://pre-commit.com/) can be used to install and
+run all the formatting tools as git hooks automatically before a
+commit.
+
+
+## Git blame ignore refs
+
+Project includes a `.git-blame-ignore-revs` file for ignoring certain commits from `git blame`.
+This can be useful for ignoring e.g. formatting commits, so that it is more clear from `git blame`
+where the actual code change came from. Configure your git to use it for this project with the
+following command:
+
+```shell
+git config blame.ignoreRevsFile .git-blame-ignore-revs
+```
+
+
+## Commit message format
+
+New commit messages must adhere to the [Conventional Commits](https://www.conventionalcommits.org/)
+specification, and line length is limited to 72 characters.
+
+When [`pre-commit`](https://pre-commit.com/) is in use, [`commitlint`](https://github.com/conventional-changelog/commitlint)
+checks new commit messages for the correct format.