cardo-python-utils 0.5.dev48__tar.gz → 0.5.dev49__tar.gz

{cardo_python_utils-0.5.dev48/cardo_python_utils.egg-info → cardo_python_utils-0.5.dev49}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cardo-python-utils
-Version: 0.5.dev48
+Version: 0.5.dev49
 Summary: Python library enhanced with a wide range of functions for different scenarios.
 Author-email: CardoAI <hello@cardoai.com>
 License: MIT

{cardo_python_utils-0.5.dev48 → cardo_python_utils-0.5.dev49/cardo_python_utils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cardo-python-utils
-Version: 0.5.dev48
+Version: 0.5.dev49
 Summary: Python library enhanced with a wide range of functions for different scenarios.
 Author-email: CardoAI <hello@cardoai.com>
 License: MIT

{cardo_python_utils-0.5.dev48 → cardo_python_utils-0.5.dev49}/cardo_python_utils.egg-info/SOURCES.txt

@@ -47,6 +47,7 @@ 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/tenant_aware_command.py
 python_utils/django/middleware/__init__.py
 python_utils/django/middleware/tenant_aware_http_middleware.py

{cardo_python_utils-0.5.dev48 → cardo_python_utils-0.5.dev49}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cardo-python-utils"
-version = "0.5.dev48"
+version = "0.5.dev49"
 description = "Python library enhanced with a wide range of functions for different scenarios."
 readme = "README.rst"
 requires-python = ">=3.8"

{cardo_python_utils-0.5.dev48 → cardo_python_utils-0.5.dev49}/python_utils/django/README.md

@@ -155,6 +155,30 @@ admin.site.has_permission = has_admin_site_permission
 
 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`
+
+```python3
+from python_utils.django.db.transaction import tenant_atomic
+
+@tenant_atomic
+def my_function():
+    ...
+```
+
+## 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:

cardo_python_utils-0.5.dev49/python_utils/django/management/commands/shell.py

@@ -0,0 +1,32 @@
+from django.core.management.commands.shell import Command as ShellCommand
+
+from ...settings import TENANT_DATABASES
+from ...tenant_context import TenantContext
+
+
+class Command(ShellCommand):
+    help = "Runs a Python interactive interpreter for a specific tenant."
+
+    def add_arguments(self, parser):
+        super().add_arguments(parser)
+
+        parser.add_argument(
+            "--tenant",
+            action="store",
+            dest="tenant",
+            help="Specify the tenant to run the shell for.",
+            required=True,
+            type=str,
+        )
+
+    def handle(self, **options):
+        tenant = options["tenant"]
+
+        if tenant not in TENANT_DATABASES:
+            self.stdout.write(self.style.ERROR(f"Tenant '{tenant}' not found in DATABASES settings."))
+            return
+
+        self.stdout.write(self.style.SUCCESS(f"Starting shell for tenant: {tenant}"))
+
+        with TenantContext(tenant):
+            super().handle(**options)