django-ultratenant 0.0.1

Ultimate Django app for multi-tenant.

Django Ultratenant

Ultimate Django app for multi-tenant.

• Documentation: https://django-ultratenant.readthedocs.io.

Installation

pip install django-ultratenant

How to Use

• TODO

Pitch (Portuguese)

• Part 1: https://www.loom.com/share/a90948958c184a0fb64868bbb0230a28

• Part 2: https://www.loom.com/share/52fd66b6f5a047f88a9fed56c1cf70d1

What is

• Django multi-tenant library that implements diferent approachs

• simple API with minimal setup

• transparent for the application

• suported isolations approachs: multi-db, multi-schema and tenant-id

• supported URL approachs: subdomain and path

  • tenant.url.com

  • url.com/tenant/admin/

• support to multiple database suporte

• good documentation

Alternatives

• https://github.com/django-tenants/django-tenants/ - only Postgres with multi-schema

• https://github.com/citusdata/django-multitenant - only Postgres (with Citus extension)

Base projects

• https://github.com/henriquebastos/pds-multi-tenant/

• https://github.com/eli-junior/djangoDefault/

MVP

• setup and pip

• SQLite3 support

• multi-db

• tenant on URL path

• documetation about how customize manage.py

• custom urls.py

  • investigate if it’s possible to change the settings.ROOT_URL to enable tenant without changing urls.py

API

# settings.py
from ultratenant.multidb import Databases
...
MIDDLEWARE = [
    ...
    'ultratenant.path.Middleware',
]
...
DATABASES = Databases(config('DATABASE_URL', cast=dburl))
DATABASE_ROUTERS = ['ultratenant.multidb.Router']

(maybe it won’t be necessary)

# urls.py
...
from ultimate_tenants.urls import tenants_path

urlpatterns = tenants_path([
    path('admin/', admin.site.urls),
    path('', index, name='index'),
])

# url.com/tenant/admin

Roadmap

• other databases supported by Django: PostgreSQL, MariaDB, MySQL, Oracle

• multi-schema

• tenant as subdomain

  • tenant.url.com/admin

• tenant-id

• custom manage.py to access different tenants

• cookiecutter to create a new project

Changelog

0.0.1 (2022-07-31)

• First release on PyPI.