cardo-python-utils 0.4.2__tar.gz → 0.5.0__tar.gz

cardo_python_utils-0.5.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include LICENSE
+include README.rst
+include python_utils/django/admin/templates/user_groups_changelist.html
+include python_utils/django/README.md
+recursive-exclude tests *

{cardo_python_utils-0.4.2/cardo_python_utils.egg-info → cardo_python_utils-0.5.0}/PKG-INFO

@@ -1,40 +1,45 @@
 Metadata-Version: 2.4
 Name: cardo-python-utils
-Version: 0.4.2
+Version: 0.5.0
 Summary: Python library enhanced with a wide range of functions for different scenarios.
-Home-page: https://github.com/CardoAI/cardo-python-utils
-Author: Kristi Kotini
-Author-email: hello@cardoai.com
-License: MIT (X11)
+Author-email: CardoAI <hello@cardoai.com>
+License: MIT
+Project-URL: Homepage, https://github.com/CardoAI/cardo-python-utils
+Project-URL: Repository, https://github.com/CardoAI/cardo-python-utils.git
+Project-URL: Issues, https://github.com/CardoAI/cardo-python-utils/issues
+Keywords: utilities,helpers,django
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
+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.8
-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 :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
 License-File: LICENSE
-Provides-Extra: pandas
-Requires-Dist: pandas>=1.4.0; extra == "pandas"
-Provides-Extra: django
-Requires-Dist: Django; extra == "django"
-Requires-Dist: django-model-utils==4.2.0; extra == "django"
-Provides-Extra: rest
-Requires-Dist: djangorestframework; extra == "rest"
-Requires-Dist: requests; extra == "rest"
+Provides-Extra: django-keycloak
+Requires-Dist: PyJWT>=2.10.1; extra == "django-keycloak"
+Requires-Dist: mozilla-django-oidc>=4.0.1; extra == "django-keycloak"
+Requires-Dist: requests; extra == "django-keycloak"
+Provides-Extra: django-keycloak-groups
+Requires-Dist: python-keycloak>=5.8.1; extra == "django-keycloak-groups"
 Provides-Extra: all
-Requires-Dist: Django; extra == "all"
-Requires-Dist: pandas>=1.4.0; extra == "all"
-Requires-Dist: django-model-utils>=4.2.0; extra == "all"
-Requires-Dist: djangorestframework; extra == "all"
+Requires-Dist: PyJWT>=2.10.1; extra == "all"
+Requires-Dist: mozilla-django-oidc>=4.0.1; extra == "all"
+Requires-Dist: python-keycloak>=5.8.1; extra == "all"
 Requires-Dist: requests; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-django>=4.5; extra == "dev"
+Requires-Dist: coverage>=6.0; extra == "dev"
+Requires-Dist: tox>=3.25; extra == "dev"
 Dynamic: license-file
 
 ============================
@@ -50,9 +55,7 @@ Main utils:
 * data_structures
 * db
 * django
-* django_rest
 * math
-* pandas
 * exception
 * choices
 
@@ -64,7 +67,7 @@ Quick start
     from python_utils.time import date_range
     date_range(start_date, end_date)
 
-Although the library provides some utility functions related to other libraries like django and pandas, it does not install any dependencies automatically.
+Although the library provides some utility functions related to other libraries like django, it does not install any dependencies automatically.
 This means, you can install the library even if you do not use these libraries, but keep in mind that in this case you cannot use the
 functions that depend on them.
 
@@ -74,7 +77,7 @@ You can also chose to install the dependencies alongside the library, including
 
 Tests
 -----
-The library has a 100% coverage by tests. If you want to see tests in action:
+The library has a high coverage by tests. If you want to see tests in action:
 
 1. Inside venv, run  ``pip install -r tests/requirements.txt``
 

{cardo_python_utils-0.4.2 → cardo_python_utils-0.5.0}/README.rst

@@ -11,9 +11,7 @@ Main utils:
 * data_structures
 * db
 * django
-* django_rest
 * math
-* pandas
 * exception
 * choices
 
@@ -25,7 +23,7 @@ Quick start
     from python_utils.time import date_range
     date_range(start_date, end_date)
 
-Although the library provides some utility functions related to other libraries like django and pandas, it does not install any dependencies automatically.
+Although the library provides some utility functions related to other libraries like django, it does not install any dependencies automatically.
 This means, you can install the library even if you do not use these libraries, but keep in mind that in this case you cannot use the
 functions that depend on them.
 
@@ -35,7 +33,7 @@ You can also chose to install the dependencies alongside the library, including
 
 Tests
 -----
-The library has a 100% coverage by tests. If you want to see tests in action:
+The library has a high coverage by tests. If you want to see tests in action:
 
 1. Inside venv, run  ``pip install -r tests/requirements.txt``
 

{cardo_python_utils-0.4.2 → cardo_python_utils-0.5.0/cardo_python_utils.egg-info}/PKG-INFO

@@ -1,40 +1,45 @@
 Metadata-Version: 2.4
 Name: cardo-python-utils
-Version: 0.4.2
+Version: 0.5.0
 Summary: Python library enhanced with a wide range of functions for different scenarios.
-Home-page: https://github.com/CardoAI/cardo-python-utils
-Author: Kristi Kotini
-Author-email: hello@cardoai.com
-License: MIT (X11)
+Author-email: CardoAI <hello@cardoai.com>
+License: MIT
+Project-URL: Homepage, https://github.com/CardoAI/cardo-python-utils
+Project-URL: Repository, https://github.com/CardoAI/cardo-python-utils.git
+Project-URL: Issues, https://github.com/CardoAI/cardo-python-utils/issues
+Keywords: utilities,helpers,django
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
+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.8
-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 :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
 License-File: LICENSE
-Provides-Extra: pandas
-Requires-Dist: pandas>=1.4.0; extra == "pandas"
-Provides-Extra: django
-Requires-Dist: Django; extra == "django"
-Requires-Dist: django-model-utils==4.2.0; extra == "django"
-Provides-Extra: rest
-Requires-Dist: djangorestframework; extra == "rest"
-Requires-Dist: requests; extra == "rest"
+Provides-Extra: django-keycloak
+Requires-Dist: PyJWT>=2.10.1; extra == "django-keycloak"
+Requires-Dist: mozilla-django-oidc>=4.0.1; extra == "django-keycloak"
+Requires-Dist: requests; extra == "django-keycloak"
+Provides-Extra: django-keycloak-groups
+Requires-Dist: python-keycloak>=5.8.1; extra == "django-keycloak-groups"
 Provides-Extra: all
-Requires-Dist: Django; extra == "all"
-Requires-Dist: pandas>=1.4.0; extra == "all"
-Requires-Dist: django-model-utils>=4.2.0; extra == "all"
-Requires-Dist: djangorestframework; extra == "all"
+Requires-Dist: PyJWT>=2.10.1; extra == "all"
+Requires-Dist: mozilla-django-oidc>=4.0.1; extra == "all"
+Requires-Dist: python-keycloak>=5.8.1; extra == "all"
 Requires-Dist: requests; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-django>=4.5; extra == "dev"
+Requires-Dist: coverage>=6.0; extra == "dev"
+Requires-Dist: tox>=3.25; extra == "dev"
 Dynamic: license-file
 
 ============================
@@ -50,9 +55,7 @@ Main utils:
 * data_structures
 * db
 * django
-* django_rest
 * math
-* pandas
 * exception
 * choices
 
@@ -64,7 +67,7 @@ Quick start
     from python_utils.time import date_range
     date_range(start_date, end_date)
 
-Although the library provides some utility functions related to other libraries like django and pandas, it does not install any dependencies automatically.
+Although the library provides some utility functions related to other libraries like django, it does not install any dependencies automatically.
 This means, you can install the library even if you do not use these libraries, but keep in mind that in this case you cannot use the
 functions that depend on them.
 
@@ -74,7 +77,7 @@ You can also chose to install the dependencies alongside the library, including
 
 Tests
 -----
-The library has a 100% coverage by tests. If you want to see tests in action:
+The library has a high coverage by tests. If you want to see tests in action:
 
 1. Inside venv, run  ``pip install -r tests/requirements.txt``
 

cardo_python_utils-0.5.0/cardo_python_utils.egg-info/SOURCES.txt

@@ -0,0 +1,74 @@
+LICENSE
+MANIFEST.in
+README.rst
+pyproject.toml
+cardo_python_utils.egg-info/PKG-INFO
+cardo_python_utils.egg-info/SOURCES.txt
+cardo_python_utils.egg-info/dependency_links.txt
+cardo_python_utils.egg-info/requires.txt
+cardo_python_utils.egg-info/top_level.txt
+python_utils/__init__.py
+python_utils/choices.py
+python_utils/data_structures.py
+python_utils/db.py
+python_utils/django_utils.py
+python_utils/esma_choices.py
+python_utils/exceptions.py
+python_utils/imports.py
+python_utils/math.py
+python_utils/text.py
+python_utils/time.py
+python_utils/types_hinting.py
+python_utils/django/README.md
+python_utils/django/__init__.py
+python_utils/django/apps.py
+python_utils/django/oidc_settings.py
+python_utils/django/settings.py
+python_utils/django/tenant_context.py
+python_utils/django/admin/__init__.py
+python_utils/django/admin/auth.py
+python_utils/django/admin/user_group.py
+python_utils/django/admin/views.py
+python_utils/django/admin/templates/__init__.py
+python_utils/django/admin/templates/user_groups_changelist.html
+python_utils/django/api/__init__.py
+python_utils/django/api/drf.py
+python_utils/django/api/ninja.py
+python_utils/django/api/utils.py
+python_utils/django/auth/service.py
+python_utils/django/celery/__init__.py
+python_utils/django/celery/tenant_aware_database_scheduler.py
+python_utils/django/celery/tenant_aware_task.py
+python_utils/django/db/__init__.py
+python_utils/django/db/alias.py
+python_utils/django/db/routers.py
+python_utils/django/db/transaction.py
+python_utils/django/db/utils.py
+python_utils/django/management/__init__.py
+python_utils/django/management/commands/__init__.py
+python_utils/django/management/commands/migrateall.py
+python_utils/django/management/commands/shell.py
+python_utils/django/management/commands/showmigrations.py
+python_utils/django/management/commands/tenant_aware_command.py
+python_utils/django/middleware/__init__.py
+python_utils/django/middleware/tenant_aware_http_middleware.py
+python_utils/django/middleware/tenant_aware_websocket_middleware.py
+python_utils/django/migrations/0001_initial.py
+python_utils/django/migrations/0001_initial_squashed_0005_alter_userrole_id.py
+python_utils/django/migrations/0002_auto_20220120_1617.py
+python_utils/django/migrations/0003_auto_20220513_1025.py
+python_utils/django/migrations/0004_auto_20220817_1526.py
+python_utils/django/migrations/0005_alter_userrole_id.py
+python_utils/django/migrations/0006_userrole_organization_and_more.py
+python_utils/django/migrations/0007_user_demo.py
+python_utils/django/migrations/0008_delete_userrole.py
+python_utils/django/migrations/__init__.py
+python_utils/django/models/__init__.py
+python_utils/django/models/user.py
+python_utils/django/models/user_group.py
+python_utils/django/redis/__init__.py
+python_utils/django/redis/key_function.py
+python_utils/django/storage/__init__.py
+python_utils/django/storage/tenant_aware_storage.py
+python_utils/django/tests/__init__.py
+python_utils/django/tests/conftest.py

cardo_python_utils-0.5.0/cardo_python_utils.egg-info/requires.txt

@@ -0,0 +1,20 @@
+
+[all]
+PyJWT>=2.10.1
+mozilla-django-oidc>=4.0.1
+python-keycloak>=5.8.1
+requests
+
+[dev]
+pytest>=7.0
+pytest-django>=4.5
+coverage>=6.0
+tox>=3.25
+
+[django-keycloak]
+PyJWT>=2.10.1
+mozilla-django-oidc>=4.0.1
+requests
+
+[django-keycloak-groups]
+python-keycloak>=5.8.1

{cardo_python_utils-0.4.2 → cardo_python_utils-0.5.0}/cardo_python_utils.egg-info/top_level.txt

@@ -1 +1,2 @@
+dist
 python_utils

cardo_python_utils-0.5.0/pyproject.toml

@@ -0,0 +1,74 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cardo-python-utils"
+version = "0.5.0"
+description = "Python library enhanced with a wide range of functions for different scenarios."
+readme = "README.rst"
+requires-python = ">=3.8"
+license = {text = "MIT"}
+authors = [
+    {name = "CardoAI", email = "hello@cardoai.com"},
+]
+keywords = ["utilities", "helpers", "django"]
+classifiers = [
+    "Environment :: Web Environment",
+    "Framework :: Django",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+]
+dependencies = []
+
+[project.optional-dependencies]
+django-keycloak = [
+    "PyJWT>=2.10.1",
+    "mozilla-django-oidc>=4.0.1",
+    "requests",
+]
+django-keycloak-groups = [
+    "python-keycloak>=5.8.1",
+]
+all = [
+    "PyJWT>=2.10.1",
+    "mozilla-django-oidc>=4.0.1",
+    "python-keycloak>=5.8.1",
+    "requests",
+]
+dev = [
+    "pytest>=7.0",
+    "pytest-django>=4.5",
+    "coverage>=6.0",
+    "tox>=3.25",
+]
+
+[project.urls]
+Homepage = "https://github.com/CardoAI/cardo-python-utils"
+Repository = "https://github.com/CardoAI/cardo-python-utils.git"
+Issues = "https://github.com/CardoAI/cardo-python-utils/issues"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["."]
+exclude = ["tests", "tests.*"]
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "tests.settings"
+django_find_project = false
+python_files = ["tests.py", "test_*.py", "*_tests.py"]
+addopts = "--strict-markers --no-migrations --reuse-db --log-cli-level=INFO --doctest-modules"
+
+[tool.tox]
+legacy_tox_ini = "tox.ini"

{cardo_python_utils-0.4.2 → cardo_python_utils-0.5.0}/python_utils/choices.py

@@ -9,6 +9,7 @@ It adds some useful methods to the Enum class, such as:
 
 from abc import ABC, abstractmethod
 from enum import EnumMeta, Enum
+from typing import Union
 
 
 class IChoice(ABC):
@@ -41,7 +42,7 @@ class ChoiceEnumMeta(EnumMeta, IChoice, ABC):
 
         return new_cls
 
-    def __contains__(cls, item: int | str) -> bool:
+    def __contains__(cls, item: Union[int, str]) -> bool:
         if isinstance(item, int):
             member_values = [v.value[0] for v in cls.__members__.values()]
         elif isinstance(item, str):
@@ -75,12 +76,12 @@ class ChoiceEnum(Enum, metaclass=ChoiceEnumMeta):
         return {elm.value[0]: elm.value[1] for elm in cls}
 
     @classmethod
-    def get_by_value(cls, value: str | int):
-        value_index = 0 if type(value) == int else 1
+    def get_by_value(cls, value: Union[str, int]):
+        value_index = 0 if isinstance(value, int) else 1
         return next((v for v in cls.__members__.values() if v.value[value_index] == value), None)
 
     @classmethod
-    def list_as(cls, item_type) -> list[int | str]:
+    def list_as(cls, item_type) -> list[Union[int, str]]:
         if item_type not in [int, str]:
             raise TypeError('Invalid item type')
         return list(map(item_type, cls))

cardo_python_utils-0.5.0/python_utils/django/README.md

@@ -0,0 +1,227 @@
+This package provides utilities for facilitating IDP communication and multi-tenancy support.
+
+# Usage
+
+## Environment variables to set
+
+- AWS_STORAGE_TENANT_BUCKET_NAMES
+  - _This variable should be set if separate tenant buckets are needed._
+  - A JSON dictionary where each key is the tenant name and the value is the bucket name.
+- DATABASE_CONFIG
+  - A JSON dictionary where each key is the tenant name and the value is a dict with the datase config.
+  - If multiple 'DATABASE_CONFIG'-prefixed variables are set, they will be merged into a single dictionary.
+- KEYCLOAK_CONFIDENTIAL_CLIENT_ID
+  - The id of the confidential client of the backend service
+- KEYCLOAK_CONFIDENTIAL_CLIENT_SERVICE_ACCOUNT_TOKEN_FILE_PATHS
+  - A JSON dictionary where each key is the tenant name and the value is the file path of the service account token for the confidential client of that tenant
+
+## settings.py file
+
+### For multi-tenancy
+
+```python3
+INSTALLED_APPS = [
+    ...
+    "python_utils.django",
+    ...
+]
+
+MIDDLEWARE = [
+    "python_utils.django.middleware.TenantAwareHttpMiddleware",
+    ...
+]
+
+AUTH_USER_MODEL = "idp_user.User"
+
+# Include the database configuration for each tenant in the DATABASES setting.
+# You can use the get_database_configs() function from python_utils.django.db.utils as a helper.
+from python_utils.django.db.utils import get_database_configs
+
+for tenant, tenant_db_config in get_database_configs().items():
+    DATABASES[tenant] = {
+        "ENGINE": "django.db.backends.postgresql",
+        "NAME": tenant_db_config["name"],
+        "USER": tenant_db_config["user"],
+        "PASSWORD": tenant_db_config["password"],
+        "HOST": tenant_db_config["host"],
+        "PORT": tenant_db_config.get("port", 5432),
+    }
+
+# If you want to override the database alias to use for local development (when DEBUG is True).
+# By default, the first database defined in DATABASES is used.
+DEVELOPMENT_TENANT = "development"
+
+# This is required to use the tenant context when routing database queries
+DATABASE_ROUTERS = ["python_utils.django.db.routers.TenantAwareRouter"]
+
+# If using celery, set the task class to TenantAwareTask:
+CELERY_TASK_CLS = "python_utils.django.celery.TenantAwareTask"
+
+# If using Redis caching, configure the cache backend as follows:
+CACHES = {
+    "default": {
+        "BACKEND": "django_redis.cache.RedisCache",
+        "LOCATION": REDIS_LOCATION,
+        "KEY_FUNCTION": "python_utils.django.redis.make_tenant_aware_key",
+        **OPTIONS,
+    }
+}
+
+# If using Django Storages with S3, and separate tenant buckets are needed, 
+# configure the storage backends as follows:
+STORAGES = {
+    "default": {
+        "BACKEND": "python_utils.django.storage.TenantAwarePrivateS3Storage",
+    },
+}
+
+# If you want to exclude certain paths from tenant processing, use TENANT_AWARE_EXCLUDED_PATHS:
+# They are considered as prefixes, so all paths starting with the given strings will be excluded.
+TENANT_AWARE_EXCLUDED_PATHS = ("/some/path",)
+```
+
+### For OIDC auth
+
+```python3
+from python_utils.django.admin.templates import TEMPLATE_PATH
+
+INSTALLED_APPS.append("mozilla_django_oidc")
+TEMPLATES[0]["DIRS"].append(TEMPLATE_PATH)
+
+JWT_AUDIENCE = "myapp"
+JWT_SCOPE_PREFIX = "myapp"
+
+# If using DRF
+REST_FRAMEWORK.update(
+    {
+        "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
+        "DEFAULT_AUTHENTICATION_CLASSES": ("python_utils.django.api.drf.AuthenticationBackend",),
+        "DEFAULT_PERMISSION_CLASSES": (
+            "rest_framework.permissions.IsAuthenticated",
+            "python_utils.django.api.drf.HasScope",
+        ),
+    }
+)
+
+# Admin auth backends
+AUTHENTICATION_BACKENDS = [
+    "django.contrib.auth.backends.ModelBackend",
+    "python_utils.django.admin.auth.AdminAuthenticationBackend",
+]
+
+# If user groups are used for Row Level Security (RLS)
+KEYCLOAK_USER_GROUP_MODEL = "myapp.UserGroup"
+
+KEYCLOAK_CONFIDENTIAL_CLIENT_ID = os.getenv("KEYCLOAK_CONFIDENTIAL_CLIENT_ID", f"{JWT_AUDIENCE}_confidential")
+
+OIDC_RP_CLIENT_ID = KEYCLOAK_CONFIDENTIAL_CLIENT_ID
+OIDC_RP_SIGN_ALGO = "RS256"
+OIDC_CREATE_USER = True
+OIDC_AUTHENTICATE_CLASS = "python_utils.django.admin.views.TenantAwareOIDCAuthenticationRequestView"
+
+LOGIN_REDIRECT_URL = "/admin"
+SESSION_COOKIE_AGE = 60 * 30  # 30 minutes
+SESSION_SAVE_EVERY_REQUEST = True  # Extend session on each request
+
+# If using django-easy-audit
+
+from python_utils.django.db.alias import DynamicDatabaseAlias
+DJANGO_EASY_AUDIT_DATABASE_ALIAS = DynamicDatabaseAlias()
+```
+
+## urls.py file
+
+The views of the `mozilla-django-oidc` package need to be exposed as well, for the OIDC auth:
+
+```python3
+urlpatterns.append(path("oidc/", include("mozilla_django_oidc.urls")))
+```
+
+## admin.py file
+
+The Django Admin Panel needs to be configured to automatically redirect to the OIDC login page:
+
+```python3
+from python_utils.django.admin.auth import has_admin_site_permission
+from python_utils.django.admin.views import TenantAwareOIDCAuthenticationRequestView
+
+admin.site.login = TenantAwareOIDCAuthenticationRequestView.as_view()
+admin.site.has_permission = has_admin_site_permission
+```
+
+## With django-ninja
+
+If using `django-ninja`, apart from the settings configured above, auth utils are provided in the django/api/ninja.py module.
+
+## Atomic Transactions
+
+Django's `transaction.atomic` uses the default database. To make it tenant-aware, use `tenant_atomic`.
+If `transaction.on_commit` is used, make sure to pass the tenant as DB alias as well:
+
+```python3
+from python_utils.django.db.transaction import tenant_atomic
+
+@tenant_atomic
+def my_function():
+    # Some logic
+
+    transaction.on_commit(do_smth, using=TenantContext.get())
+```
+
+## Explicit database connection
+
+If using django.db.connection anywhere in the code, you need to change that to get a tenant-aware connection:
+
+```python3
+from python_utils.django.db.utils import get_connection
+from python_utils.django.tenant_context import TenantContext
+
+connection = get_connection(TenantContext.get())
+```
+
+## Django Shell
+
+This library overrides the shell command of Django, so that it requires the `tenant` arg. 
+This way, the shell is automatically initialized with the context set to the tenant. 
+
+```bash
+./manage.py shell --tenant=tenant1
+
+Starting shell for tenant: -tenant=tenant
+>>>
+```
+
+## Testing
+
+In order for tests to work, create the following autouse fixtures:
+
+```python3
+import pytest
+
+from python_utils.django.tenant_context import TenantContext
+
+# Add this, if the test utils of the package are needed
+pytest_plugins = ["python_utils.django.tests"]
+
+
+@pytest.fixture(scope="session", autouse=True)
+def test_database() -> str:
+    return "default"
+
+
+@pytest.fixture(scope="session", autouse=True)
+def set_tenant_context_session(test_database):
+    """Set tenant context for the entire test session."""
+    TenantContext.set(test_database)
+    yield
+    TenantContext.clear()
+
+
+@pytest.fixture(autouse=True)
+def set_tenant_context(set_tenant_context_session, test_database):
+    """Ensure tenant context is set for each test (depends on session fixture)."""
+    # Re-set in case it was cleared between tests
+    if not TenantContext.is_set():
+        TenantContext.set(test_database)
+    yield
+```

cardo_python_utils-0.5.0/python_utils/django/__init__.py

@@ -0,0 +1 @@
+default_app_config = "python_utils.django.apps.DjangoAppConfig"