django-log-formatter-asim 0.0.4__tar.gz → 0.0.6__tar.gz

{django_log_formatter_asim-0.0.4 → django_log_formatter_asim-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-log-formatter-asim
-Version: 0.0.4
+Version: 0.0.6
 Summary: Formats Django logs in ASIM format.
 License: MIT
 Author: Department for Business and Trade Platform Team
@@ -11,7 +11,9 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: django (>=3,<5)
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: django (>=3,<5) ; python_version >= "3.9" and python_version < "3.10"
+Requires-Dist: django (>=3,<6) ; python_version >= "3.10" and python_version < "4"
 Requires-Dist: pre-commit (>=3.5.0,<4.0.0)
 Description-Content-Type: text/markdown
 
@@ -49,14 +51,20 @@ LOGGING = {
             ...
         },
     },
+    "root": {
+        "handlers": ["asim"],
+        ...
+    }
     "loggers": {
         "django": {
             "handlers": ["asim"],
+            "propagate": False
             ...
         },
     },
 }
 ```
+In this example we assign the ASIM formatter to a `handler` and ensure both `root` and `django` loggers use this `handler`. We then set `propagate` to `False` on the `django` logger, to avoid duplicating logs at the root level. 
 
 ## Dependencies
 
@@ -132,3 +140,35 @@ Run `poetry run pytest` in the root directory to run all tests.
 
 Or, run `poetry run tox` in the root directory to run all tests for multiple Python versions. See the [`tox` configuration file](tox.ini).
 
+### Publishing
+
+1. Acquire API token from [Passman](https://passman.ci.uktrade.digital/secret/cc82a3f7-ddfa-4312-ab56-1ff8528dadc8/).
+   - Request access from the SRE team.
+   - _Note: You will need access to the `platform` group in Passman._
+2. Run `poetry config pypi-token.pypi <token>` to add the token to your Poetry configuration.
+
+Update the version, as the same version cannot be published to PyPI.
+
+```
+poetry version patch
+```
+
+More options for the `version` command can be found in the [Poetry documentation](https://python-poetry.org/docs/cli/#version). For example, for a minor version bump: `poetry version minor`.
+
+Build the Python package.
+
+```
+poetry build
+```
+
+Publish the Python package.
+
+_Note: Make sure your Pull Request (PR) is approved and contains the version upgrade in `pyproject.toml` before publishing the package._
+
+```
+poetry publish
+```
+
+Check the [PyPI Release history](https://pypi.org/project/django-log-formatter-asim/#history) to make sure the package has been updated.
+
+For an optional manual check, install the package locally and test everything works as expected.

{django_log_formatter_asim-0.0.4 → django_log_formatter_asim-0.0.6}/README.md

@@ -32,14 +32,20 @@ LOGGING = {
             ...
         },
     },
+    "root": {
+        "handlers": ["asim"],
+        ...
+    }
     "loggers": {
         "django": {
             "handlers": ["asim"],
+            "propagate": False
             ...
         },
     },
 }
 ```
+In this example we assign the ASIM formatter to a `handler` and ensure both `root` and `django` loggers use this `handler`. We then set `propagate` to `False` on the `django` logger, to avoid duplicating logs at the root level. 
 
 ## Dependencies
 
@@ -114,3 +120,36 @@ If you wish to create your own ASIM formatter, you can inherit from ASIMSystemFo
 Run `poetry run pytest` in the root directory to run all tests.
 
 Or, run `poetry run tox` in the root directory to run all tests for multiple Python versions. See the [`tox` configuration file](tox.ini).
+
+### Publishing
+
+1. Acquire API token from [Passman](https://passman.ci.uktrade.digital/secret/cc82a3f7-ddfa-4312-ab56-1ff8528dadc8/).
+   - Request access from the SRE team.
+   - _Note: You will need access to the `platform` group in Passman._
+2. Run `poetry config pypi-token.pypi <token>` to add the token to your Poetry configuration.
+
+Update the version, as the same version cannot be published to PyPI.
+
+```
+poetry version patch
+```
+
+More options for the `version` command can be found in the [Poetry documentation](https://python-poetry.org/docs/cli/#version). For example, for a minor version bump: `poetry version minor`.
+
+Build the Python package.
+
+```
+poetry build
+```
+
+Publish the Python package.
+
+_Note: Make sure your Pull Request (PR) is approved and contains the version upgrade in `pyproject.toml` before publishing the package._
+
+```
+poetry publish
+```
+
+Check the [PyPI Release history](https://pypi.org/project/django-log-formatter-asim/#history) to make sure the package has been updated.
+
+For an optional manual check, install the package locally and test everything works as expected.

{django_log_formatter_asim-0.0.4 → django_log_formatter_asim-0.0.6}/pyproject.toml

@@ -3,7 +3,7 @@ line-length = 100
 
 [tool.poetry]
 name = "django-log-formatter-asim"
-version = "0.0.4"
+version = "0.0.6"
 description = "Formats Django logs in ASIM format."
 authors = ["Department for Business and Trade Platform Team <sre-team@digital.trade.gov.uk>"]
 license = "MIT"
@@ -13,9 +13,12 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-django = ">=3,<5"
 python = ">=3.9,<4"
 pre-commit = "^3.5.0"
+django = [
+    { version = ">=3,<5", python = ">=3.9,<3.10" },
+    { version = ">=3,<6", python = ">=3.10,<4" },
+]
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^3.5.0"