Metadata-Version: 2.4
Name: lacrei-models
Version: 3.4.12
Summary: Modelos de domínio do projeto Lacrei.
Author: Kaio
Author-email: kaioherculano12@gmail.com
Requires-Python: ==3.13.11
Classifier: Programming Language :: Python :: 3
Requires-Dist: celery (>=5.5.3,<6.0.0)
Requires-Dist: django (>=4.0)
Requires-Dist: django-allauth (>=65.4.1,<66.0.0)
Requires-Dist: django-environ (>=0.12.0,<0.13.0)
Requires-Dist: django-phonenumber-field (>=8.1.0,<9.0.0)
Requires-Dist: django-watson (>=1.6.3,<2.0.0)
Requires-Dist: djangorestframework (>=3.16.1,<4.0.0)
Requires-Dist: dnspython (>=2.8.0,<3.0.0)
Requires-Dist: inlinestyler (>=0.2.5,<0.3.0)
Requires-Dist: phonenumbers (>=9.0.14,<10.0.0)
Requires-Dist: psycopg2-binary (>=2.9.10,<3.0.0)
Requires-Dist: pydantic (>=2.11.9,<3.0.0)
Requires-Dist: python-statemachine (>=3.0.0,<4.0.0)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Description-Content-Type: text/markdown

# Lacrei Models

Pacote centralizado para os modelos de domínio (`models.py`) do ecossistema Lacrei.

[![Python Version](https://img.shields.io/badge/python-3.13+-blue.svg)](https://www.python.org/downloads/)

---

## 🎯 Objetivo

Centralizar todos os modelos do Django utilizados pelas aplicações Lacrei, permitindo:

- **Modularidade:** Desacoplar a camada de dados da lógica de aplicação.
- **Reuso:** Serviços diferentes podem consumir os mesmos modelos de forma consistente.
- **Governança e Consistência:** Ponto único de verdade para estrutura de dados.

É uma dependência interna, destinada a ser usada por aplicações como `lacrei-api`.

---

### Configurações Iniciais

1.  **Clone o Repositório, na mesmo local onde se encontra a lacrei-api e a lacrei-migrations:**
```bash
    git clone https://github.com/Lacrei/lacrei-models.git
    cd lacrei-models
```

2.  **Instale as Dependências:**
```bash
    make install
    poetry add lacrei-models
```
---

## ⚙️ Uso

Para testar localmente as mudanças na models antes de pubicar no PyPI:
```bash
poetry add --editable C:/local onde se encontra o lacrei-models
```

Importe os modelos no código:

```python
from lacrei_models.address.models import Address
from lacrei_models.client.models import User
from lacrei_models.appointments.models import Appointment
from lacrei_models.professional.models import Professional
from lacrei_models.notification.models import Notification
from lacrei_models.payment.models import Payment
from lacrei_models.sync.models import GoogleAccount
```

---

**Comandos principais:**

```bash
make test      # Rodar testes
make format    # Formatar código
make lint      # Verificar estilo e erros
make quality   # Rodar todas as verificações
```

---

## � Pre-commit Hooks

O projeto utiliza **pre-commit hooks** para garantir qualidade do código automaticamente antes de cada commit.

### Como funciona

- **Execução automática**: Os hooks rodam antes de cada commit
- **Validação**: Se algum check falhar, o commit é bloqueado
- **Correção automática**: Black e isort corrigem o código automaticamente
- **Re-commit necessário**: Após correções, adicione as mudanças e tente commitar novamente

Os hooks são instalados automaticamente ao executar `make install`.

### Comandos Individuais

Você também pode executar as ferramentas de lint individualmente:

```bash
# Black - Formatar código automaticamente
poetry run black .

# isort - Ordenar e agrupar imports
poetry run isort .

# Flake8 - Verificar estilo e erros (sem alteração automática)
poetry run flake8 .
```

### Bypass de Hooks (Uso Excepcional)

Em casos específicos, você pode pular os hooks:

```bash
git commit --no-verify -m "mensagem"
# ou
git commit -n -m "mensagem"
```

**⚠️ Atenção**: Use apenas em situações excepcionais. O bypass não é recomendado pois os checks do CI continuarão validando o código.

---

## �🚀 Publicação no PyPI

A publicação é manual e deve executar sobre uma tag `vX.Y.Z`, com versão
igual à declarada no `pyproject.toml`. O commit da tag deve estar integrado
à `main`. Execuções sobre branches ou com versões divergentes são rejeitadas.

1. Escolher uma versão ainda não publicada no PyPI, atualizar o projeto e
   revisar as mudanças por PR. O workflow não altera a versão nem o lockfile.
2. Integrar o PR à `main`, incluindo o workflow e o validador de release.
3. Criar e enviar uma tag `vX.Y.Z` no commit revisado. Não mover ou reutilizar
   tags de versões publicadas.
4. Acionar a publicação explicitamente sobre a tag usando o GitHub CLI:

   ```bash
   gh workflow run publish.yml --repo Lacrei/lacrei-models --ref vX.Y.Z
   ```

   Esse comando publica no PyPI após as validações. Substituir `vX.Y.Z`
   pela tag real somente quando a release estiver pronta para publicação.
   Criar a tag, isoladamente, não dispara publicação automática.
5. Registrar na atividade/release a versão, a tag, o SHA completo e o link
   da execução. O resumo do workflow contém esses dados e os SHA-256 dos
   artefatos. O artifact `release-vX.Y.Z` preserva wheel, sdist,
   `SHA256SUMS` e `release-source.json`, sujeito à retenção do GitHub Actions.

As tags de releases antigas não recebem retroativamente este workflow.
A regra passa a valer para tags que incluam esta alteração. A proteção
contra alteração/exclusão de tags deve ser configurada nos rulesets do
repositório; não é imposta apenas por este arquivo.

Referência: [execução manual de workflows](https://docs.github.com/en/actions/how-tos/manage-workflow-runs/manually-run-a-workflow).

