dbca-utils 2.0.1__tar.gz → 2.0.3__tar.gz

{dbca-utils-2.0.1/dbca_utils.egg-info → dbca_utils-2.0.3}/PKG-INFO

@@ -1,23 +1,19 @@
 Metadata-Version: 2.1
 Name: dbca-utils
-Version: 2.0.1
-Summary: Utilities for Django/Python apps
-Home-page: https://github.com/dbca-wa/dbca-utils
-Author: Department of Biodiversity, Conservation and Attractions
-Author-email: asi@dbca.wa.gov.au
-Maintainer: Department of Biodiversity, Conservation and Attractions
-Maintainer-email: asi@dbca.wa.gov.au
-License: Apache License, Version 2.0
-Keywords: django,middleware,utility
-Platform: UNKNOWN
+Version: 2.0.3
+Summary: Utilities for DBCA Django apps
+License: Apache-2.0
+Author: Rocky Chen
+Author-email: rocky.chen@dbca.wa.gov.au
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
 Classifier: Framework :: Django :: 3.2
 Classifier: Framework :: Django :: 4.0
 Classifier: Framework :: Django :: 4.2
 Classifier: Framework :: Django :: 5.0
-Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers
-Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -25,21 +21,49 @@ Classifier: Programming Language :: Python :: 3.9
 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: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: django (>=3.2,<5.1)
 Description-Content-Type: text/markdown
-License-File: LICENSE
 
 # Overview
 
 DBCA Django utility classes and functions.
 
-# SSO Login Middleware
+## Development
+
+This project for development is using
+[Poetry](https://python-poetry.org/docs/) to install and manage a virtual Python
+environment. With Poetry installed, change into the project directory and run:
+
+    poetry install
+
+Activate the virtualenv like so:
+
+    poetry shell
+
+Run unit tests using `pytest` (or `tox`, to test against multiple Python versions):
+
+    pytest -v
+    tox -v
+
+## Releases
+
+Tagged releases are built and pushed to PyPI automatically using a GitHub
+workflow in the project. Update the project version in `pyproject.toml` and
+tag the required commit with the same value to trigger a release.
+
+## Installation
+
+1. Install via pip/Poetry/etc.: `pip install dbca-utils`
+
+## SSO Login Middleware
 
 This will automatically login and create users using headers from an upstream proxy (REMOTE_USER and some others).
 The logout view will redirect to a separate logout page which clears the SSO session.
 
-## Usage
+### Usage
 
 Add `dbca_utils.middleware.SSOLoginMiddleware` to `settings.MIDDLEWARE` (after both of
 `django.contrib.sessions.middleware.SessionMiddleware` and
@@ -51,7 +75,7 @@ on every request, and `request.user.is_authenticated` won't work properly/will b
 
 Example:
 
-```
+```python
 MIDDLEWARE = [
     ...,
     'django.contrib.sessions.middleware.SessionMiddleware',
@@ -61,13 +85,12 @@ MIDDLEWARE = [
 ]
 ```
 
-# Audit model mixin
-
-``AuditMixin`` is an extension of ``Django.db.model.Model`` that adds a number of additional fields:
+## Audit model mixin
 
- * creator - FK to ``AUTH_USER_MODEL``, used to record the object creator
- * modifier - FK to ``AUTH_USER_MODEL``, used to record who the object was last modified by
- * created - a timestamp that is set on initial object save
- * modified - an auto-updating timestamp (on each object save)
+`AuditMixin` is an extension of `Django.db.model.Model` that adds a number of additional fields:
 
+- creator - FK to `AUTH_USER_MODEL`, used to record the object creator
+- modifier - FK to `AUTH_USER_MODEL`, used to record who the object was last modified by
+- created - a timestamp that is set on initial object save
+- modified - an auto-updating timestamp (on each object save)
 

dbca_utils-2.0.3/README.md

@@ -0,0 +1,66 @@
+# Overview
+
+DBCA Django utility classes and functions.
+
+## Development
+
+This project for development is using
+[Poetry](https://python-poetry.org/docs/) to install and manage a virtual Python
+environment. With Poetry installed, change into the project directory and run:
+
+    poetry install
+
+Activate the virtualenv like so:
+
+    poetry shell
+
+Run unit tests using `pytest` (or `tox`, to test against multiple Python versions):
+
+    pytest -v
+    tox -v
+
+## Releases
+
+Tagged releases are built and pushed to PyPI automatically using a GitHub
+workflow in the project. Update the project version in `pyproject.toml` and
+tag the required commit with the same value to trigger a release.
+
+## Installation
+
+1. Install via pip/Poetry/etc.: `pip install dbca-utils`
+
+## SSO Login Middleware
+
+This will automatically login and create users using headers from an upstream proxy (REMOTE_USER and some others).
+The logout view will redirect to a separate logout page which clears the SSO session.
+
+### Usage
+
+Add `dbca_utils.middleware.SSOLoginMiddleware` to `settings.MIDDLEWARE` (after both of
+`django.contrib.sessions.middleware.SessionMiddleware` and
+`django.contrib.auth.middleware.AuthenticationMiddleware`.
+Ensure that `AUTHENTICATION_BACKENDS` contains `django.contrib.auth.backends.ModelBackend`,
+as this middleware depends on it for retrieving the logged in user for a session.
+Note that the middleware will still work without it, but will reauthenticate the session
+on every request, and `request.user.is_authenticated` won't work properly/will be false.
+
+Example:
+
+```python
+MIDDLEWARE = [
+    ...,
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'dbca_utils.middleware.SSOLoginMiddleware'
+    ...,
+]
+```
+
+## Audit model mixin
+
+`AuditMixin` is an extension of `Django.db.model.Model` that adds a number of additional fields:
+
+- creator - FK to `AUTH_USER_MODEL`, used to record the object creator
+- modifier - FK to `AUTH_USER_MODEL`, used to record who the object was last modified by
+- created - a timestamp that is set on initial object save
+- modified - an auto-updating timestamp (on each object save)

dbca_utils-2.0.3/pyproject.toml

@@ -0,0 +1,56 @@
+[tool.poetry]
+name = "dbca-utils"
+version = "2.0.3"
+description = "Utilities for DBCA Django apps"
+authors = [
+  "Rocky Chen <rocky.chen@dbca.wa.gov.au>",
+  "Ashley Felton <ashley.felton@dbca.wa.gov.au>",
+]
+license = "Apache-2.0"
+readme = "README.md"
+classifiers = [
+  "Framework :: Django",
+  "Framework :: Django :: 3.2",
+  "Framework :: Django :: 4.0",
+  "Framework :: Django :: 4.2",
+  "Framework :: Django :: 5.0",
+  "Environment :: Web Environment",
+  "Intended Audience :: Developers",
+  "Development Status :: 5 - Production/Stable",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Software Development :: Libraries",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+
+[tool.poetry.group.dev.dependencies]
+pytest-django = "^4.9.0"
+pytest-sugar = "^1.0.0"
+tox = "^4.23.2"
+
+[project.urls]
+homepage = "https://github.com/dbca-wa/dbca-utils"
+source = "https://github.com/dbca-wa/dbca-utils.git"
+changelog = "https://github.com/dbca-wa/dbca-utils/blob/master/CHANGELOG.md"
+
+[tool.poetry.dependencies]
+python = "^3.9"
+django = ">=3.2,<5.1"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+# https://pytest-django.readthedocs.io/en/latest/configuring_django.html#pyproject-toml-settings
+DJANGO_SETTINGS_MODULE = "tests.settings"
+# https://pytest-django.readthedocs.io/en/latest/managing_python_path.html#using-pytest-s-pythonpath-option
+pythonpath = ". src"
+# https://pytest-django.readthedocs.io/en/latest/faq.html#my-tests-are-not-being-found-why
+python_files = "tests.py test_*.py"

{dbca-utils-2.0.1 → dbca_utils-2.0.3/src}/dbca_utils/middleware.py

@@ -3,6 +3,7 @@ from django.conf import settings
 from django.contrib.auth import login, logout, get_user_model
 from django.utils.deprecation import MiddlewareMixin
 from django.utils.functional import SimpleLazyObject
+from django.utils import timezone
 from django.contrib.auth.middleware import AuthenticationMiddleware, get_user
 
 from dbca_utils.utils import env
@@ -161,7 +162,7 @@ class SSOLoginMiddleware(MiddlewareMixin):
             ):
                 user = User.objects.filter(username__iexact=attributemap["username"])[0]
             else:
-                user = User()
+                user = User(last_login=timezone.localtime())
 
             # Set the user's details from the supplied information.
             user.__dict__.update(attributemap)

dbca-utils-2.0.1/MANIFEST.in

@@ -1,2 +0,0 @@
-include README.md
-include LICENSE

dbca-utils-2.0.1/PKG-INFO

@@ -1,73 +0,0 @@
-Metadata-Version: 2.1
-Name: dbca-utils
-Version: 2.0.1
-Summary: Utilities for Django/Python apps
-Home-page: https://github.com/dbca-wa/dbca-utils
-Author: Department of Biodiversity, Conservation and Attractions
-Author-email: asi@dbca.wa.gov.au
-Maintainer: Department of Biodiversity, Conservation and Attractions
-Maintainer-email: asi@dbca.wa.gov.au
-License: Apache License, Version 2.0
-Keywords: django,middleware,utility
-Platform: UNKNOWN
-Classifier: Framework :: Django
-Classifier: Framework :: Django :: 3.2
-Classifier: Framework :: Django :: 4.0
-Classifier: Framework :: Django :: 4.2
-Classifier: Framework :: Django :: 5.0
-Classifier: Environment :: Web Environment
-Classifier: Intended Audience :: Developers
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# Overview
-
-DBCA Django utility classes and functions.
-
-# SSO Login Middleware
-
-This will automatically login and create users using headers from an upstream proxy (REMOTE_USER and some others).
-The logout view will redirect to a separate logout page which clears the SSO session.
-
-## Usage
-
-Add `dbca_utils.middleware.SSOLoginMiddleware` to `settings.MIDDLEWARE` (after both of
-`django.contrib.sessions.middleware.SessionMiddleware` and
-`django.contrib.auth.middleware.AuthenticationMiddleware`.
-Ensure that `AUTHENTICATION_BACKENDS` contains `django.contrib.auth.backends.ModelBackend`,
-as this middleware depends on it for retrieving the logged in user for a session.
-Note that the middleware will still work without it, but will reauthenticate the session
-on every request, and `request.user.is_authenticated` won't work properly/will be false.
-
-Example:
-
-```
-MIDDLEWARE = [
-    ...,
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'dbca_utils.middleware.SSOLoginMiddleware'
-    ...,
-]
-```
-
-# Audit model mixin
-
-``AuditMixin`` is an extension of ``Django.db.model.Model`` that adds a number of additional fields:
-
- * creator - FK to ``AUTH_USER_MODEL``, used to record the object creator
- * modifier - FK to ``AUTH_USER_MODEL``, used to record who the object was last modified by
- * created - a timestamp that is set on initial object save
- * modified - an auto-updating timestamp (on each object save)
-
-

dbca-utils-2.0.1/README.md

@@ -1,39 +0,0 @@
-# Overview
-
-DBCA Django utility classes and functions.
-
-# SSO Login Middleware
-
-This will automatically login and create users using headers from an upstream proxy (REMOTE_USER and some others).
-The logout view will redirect to a separate logout page which clears the SSO session.
-
-## Usage
-
-Add `dbca_utils.middleware.SSOLoginMiddleware` to `settings.MIDDLEWARE` (after both of
-`django.contrib.sessions.middleware.SessionMiddleware` and
-`django.contrib.auth.middleware.AuthenticationMiddleware`.
-Ensure that `AUTHENTICATION_BACKENDS` contains `django.contrib.auth.backends.ModelBackend`,
-as this middleware depends on it for retrieving the logged in user for a session.
-Note that the middleware will still work without it, but will reauthenticate the session
-on every request, and `request.user.is_authenticated` won't work properly/will be false.
-
-Example:
-
-```
-MIDDLEWARE = [
-    ...,
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'dbca_utils.middleware.SSOLoginMiddleware'
-    ...,
-]
-```
-
-# Audit model mixin
-
-``AuditMixin`` is an extension of ``Django.db.model.Model`` that adds a number of additional fields:
-
- * creator - FK to ``AUTH_USER_MODEL``, used to record the object creator
- * modifier - FK to ``AUTH_USER_MODEL``, used to record who the object was last modified by
- * created - a timestamp that is set on initial object save
- * modified - an auto-updating timestamp (on each object save)

dbca-utils-2.0.1/dbca_utils.egg-info/SOURCES.txt

@@ -1,15 +0,0 @@
-LICENSE
-MANIFEST.in
-README.md
-setup.cfg
-setup.py
-dbca_utils/__init__.py
-dbca_utils/middleware.py
-dbca_utils/models.py
-dbca_utils/utils.py
-dbca_utils.egg-info/PKG-INFO
-dbca_utils.egg-info/SOURCES.txt
-dbca_utils.egg-info/dependency_links.txt
-dbca_utils.egg-info/not-zip-safe
-dbca_utils.egg-info/requires.txt
-dbca_utils.egg-info/top_level.txt

dbca-utils-2.0.1/dbca_utils.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

dbca-utils-2.0.1/dbca_utils.egg-info/not-zip-safe

@@ -1 +0,0 @@
-

dbca-utils-2.0.1/dbca_utils.egg-info/requires.txt

@@ -1 +0,0 @@
-Django>=3.2

dbca-utils-2.0.1/dbca_utils.egg-info/top_level.txt

@@ -1 +0,0 @@
-dbca_utils

dbca-utils-2.0.1/setup.cfg

@@ -1,10 +0,0 @@
-[metadata]
-license-file = LICENSE
-
-[flake8]
-ignore = E302,E501,W503
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

dbca-utils-2.0.1/setup.py

@@ -1,47 +0,0 @@
-#!/usr/bin/env python
-
-from setuptools import setup
-from pathlib import Path
-
-# Read the contents of the README file:
-this_directory = Path(__file__).parent
-long_description = (this_directory / "README.md").read_text()
-
-setup(
-    name='dbca-utils',
-    version='2.0.1',
-    packages=['dbca_utils'],
-    description='Utilities for Django/Python apps',
-    long_description=long_description,
-    long_description_content_type='text/markdown',
-    url='https://github.com/dbca-wa/dbca-utils',
-    author='Department of Biodiversity, Conservation and Attractions',
-    author_email='asi@dbca.wa.gov.au',
-    maintainer='Department of Biodiversity, Conservation and Attractions',
-    maintainer_email='asi@dbca.wa.gov.au',
-    license='Apache License, Version 2.0',
-    zip_safe=False,
-    keywords=['django', 'middleware', 'utility'],
-    install_requires=[
-        'Django>=3.2',
-    ],
-    classifiers=[
-        'Framework :: Django',
-        'Framework :: Django :: 3.2',
-        'Framework :: Django :: 4.0',
-        'Framework :: Django :: 4.2',
-        'Framework :: Django :: 5.0',
-        'Environment :: Web Environment',
-        'Intended Audience :: Developers',
-        'Development Status :: 5 - Production/Stable',
-        'License :: OSI Approved :: Apache Software License',
-        'Programming Language :: Python',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.9',
-        'Programming Language :: Python :: 3.10',
-        'Programming Language :: Python :: 3.11',
-        'Programming Language :: Python :: 3.12',
-        'Topic :: Software Development :: Libraries',
-        'Topic :: Software Development :: Libraries :: Python Modules',
-    ],
-)