🚀 django_resaas
django_resaas é um framework modular para construção de aplicações SaaS multi-tenant em Django, com:
- 🔐 Controle de permissões (RBAC)
- 🏢 Multi-tenant (Entity / Branch)
- 🧩 Módulos ativáveis por cliente
- 💰 Billing por plano (SaaS ready)
- ♻️ Soft delete + restore
- 🔎 Busca dinâmica automática
- ⚡ BaseAPIView inteligente (DRF)
🧠 Arquitetura
User
↓
Person
↓
Employee (RH)
↓
Entity (tenant)
↓
Branch
↓
Groups + Permissões
🧩 Conceitos principais
🏢 Entity (Tenant)
Representa o cliente (empresa)
🏬 Branch
Unidade da entity
👤 Person
Dados humanos (name, email, etc.)
🔐 User
Autenticação
👥 BranchUserGroup
Relaciona:
- User
- Branch
- Group (Django)
👉 Permite múltiplos groups por branch
🔐 Sistema de Permissões (RBAC)
Baseado em:
User + Group + Permission (Django)
+ contexto (Entity + Branch)
Headers obrigatórios:
ET → entity_type
E → entity
S → branch
G → group
L → language
🧱 BaseModel
Todos os models herdam:
from django_resaas import BaseModel
Inclui:
- entity
- branch
- created_at / updated_at
- soft delete
- created_by / updated_by
🔁 Soft Delete
obj.delete() # soft delete
obj.restore() # restore
obj.hard_delete() # delete real
Managers disponíveis:
Model.objects # ativos
Model.deleted_objects # apagados
Model.all_objects # todos
⚡ BaseAPIView
CRUD automático com:
- multi-tenant automático
- permissões automáticas
- search dinâmica
- soft delete
- restore
- hard delete
Uso:
from django_resaas import BaseAPIView, register_view
@register_view(module="hr")
class EmployeeView(BaseAPIView):
queryset = Employee.objects.all()
serializer_class = EmployeeSerializer
🔍 Busca dinâmica
GET /api/employees/?search=joao
Busca automaticamente em:
- name
- código
- relações (FK)
🧩 Sistema de Módulos
Permite ativar/desativar funcionalidades por cliente.
Models:
- App
- EntityApp
Exemplo:
| Entity | Módulo | Estado |
|---|---|---|
| Empresa A | RH | ✅ |
| Empresa A | CRM | ❌ |
🔐 Proteção automática por módulo
@register_view(module="hr")
class EmployeeView(BaseAPIView):
...
👉 Se módulo não estiver ativo → acesso bloqueado
💰 Billing (SaaS)
Models:
- Plano
- PlanoApp
- EntityPlano
Fluxo:
Plano → módulos → EntityPlano → ativa módulos automaticamente
🔄 Sync automático de módulos
Ao mudar plano:
sync_apps_entity(entity)
📦 BaseSerializer
Proteção automática de arquivos:
{
"file": {
"url": "...",
"name": "...",
"ext": "pdf",
"size": 12345
}
}
🌐 Middleware
TenantContextMiddleware
Captura headers:
request.entity_id
request.branch_id
request.group_id
FrontEndMiddleware
Protege acesso por:
- chave frontend (FEK/FEP)
- permissões por URL
- permissões por método HTTP
🧪 Exemplo completo
Model
from django_resaas import BaseModel
class Employee(BaseModel):
person = models.ForeignKey('django_resaas.Person', on_delete=models.CASCADE)
cargo = models.CharField(max_length=100)
Serializer
from django_resaas import BaseSerializer
class EmployeeSerializer(BaseSerializer):
class Meta:
model = Employee
fields = "__all__"
View
from django_resaas import BaseAPIView, register_view
@register_view(module="hr")
class EmployeeView(BaseAPIView):
queryset = Employee.objects.all()
serializer_class = EmployeeSerializer
⚙️ Instalação
pip install django_resaas
ou local:
pip install -e .
🔧 Configuração
INSTALLED_APPS
INSTALLED_APPS = [
"django_resaas",
"hr",
]
Middleware
MIDDLEWARE = [
"django_resaas.core.middleware.tenant.TenantContextMiddleware",
"django_resaas.core.middleware.frontend.FrontEndMiddleware",
]
🚀 Roadmap
- Integração com Stripe
- Dashboard de billing
- Auto-router
- Auditoria de ações
- Logs multi-tenant
- Cache de permissões (Redis)
🧠 Filosofia
"Construir SaaS não deve ser repetitivo."
django_resaas resolve:
- multi-tenant
- permissões
- módulos
- billing
👉 para você focar no negócio
🤝 Contribuição
PRs são bem-vindos 🚀
📄 Licença
MIT License
👨💻 Autor
Metano Chavana
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_resaas-0.0.416.tar.gz.
File metadata
- Download URL: django_resaas-0.0.416.tar.gz
- Upload date:
- Size: 127.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c7a172c2730f679b540b1247a92a4f8dd91811b56bad40480047ac1a7dfb7972
|
|
| MD5 |
46c55f0524276e2e493d8b8795b5efa7
|
|
| BLAKE2b-256 |
079284e1f81b373709aef2eaf386f3ebbe350ba8a34d3fdf9abbc4a5a42e4ce3
|
Provenance
The following attestation bundles were made for django_resaas-0.0.416.tar.gz:
Publisher:
publish_pypi.yml on metanochava/django_resaas
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
django_resaas-0.0.416.tar.gz -
Subject digest:
c7a172c2730f679b540b1247a92a4f8dd91811b56bad40480047ac1a7dfb7972 - Sigstore transparency entry: 2580005878
- Sigstore integration time:
-
Permalink:
metanochava/django_resaas@ef8b786a100e7c64a77f751660eebbdeacd7bf8d -
Branch / Tag:
refs/tags/0.0.416 - Owner: https://github.com/metanochava
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_pypi.yml@ef8b786a100e7c64a77f751660eebbdeacd7bf8d -
Trigger Event:
push
-
Statement type:
File details
Details for the file django_resaas-0.0.416-py3-none-any.whl.
File metadata
- Download URL: django_resaas-0.0.416-py3-none-any.whl
- Upload date:
- Size: 202.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bc4bf8f8339c76fa476e0234c82981233bbf264373c6dd7ad6baae5f6ac2cc05
|
|
| MD5 |
7982ca136b084a19548ae361447c7c95
|
|
| BLAKE2b-256 |
a91afac1384063998efe822370d12cc02aa4a5476ffe099417fef30bce2195d0
|
Provenance
The following attestation bundles were made for django_resaas-0.0.416-py3-none-any.whl:
Publisher:
publish_pypi.yml on metanochava/django_resaas
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
django_resaas-0.0.416-py3-none-any.whl -
Subject digest:
bc4bf8f8339c76fa476e0234c82981233bbf264373c6dd7ad6baae5f6ac2cc05 - Sigstore transparency entry: 2580005883
- Sigstore integration time:
-
Permalink:
metanochava/django_resaas@ef8b786a100e7c64a77f751660eebbdeacd7bf8d -
Branch / Tag:
refs/tags/0.0.416 - Owner: https://github.com/metanochava
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_pypi.yml@ef8b786a100e7c64a77f751660eebbdeacd7bf8d -
Trigger Event:
push
-
Statement type:
