Metadata-Version: 2.4
Name: ps_pessoas_fastapi_lib
Version: 0.1.0
Summary: Biblioteca do model de Pessoa e Endereço com banco de dados.
Home-page: https://github.com/douglasbolis/ps_pessoa_fastapi_lib
Author: Douglas Lima
Author-email: douglasbolislima@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python
Dynamic: summary

# ps_pessoa_fastapi_lib

Lib de Cadastro de Pessoas e Endereços desenvolvida com SQLModel.
Aplicação de Cadastro de Pessoas e Endereços desenvolvida com FastAPI e a lib implementada.

## Visão Geral

Este projeto simula o funcionamento de um banco de pessoas, permitindo o cadastro e gerenciamento de pessoas e endereços. Utiliza FastAPI para a API REST e SQLModel para o mapeamento dos modelos e persistência em banco de dados.

## Funcionalidades

- Cadastro de pessoas
- Cadastro de endereços
- Validações automáticas via FastAPI

## Requisitos

- [Python 3.11+](https://www.python.org/about/)
- [FastAPI](https://fastapi.tiangolo.com/)
- [SQLModel](https://sqlmodel.tiangolo.com/)

## Ambiente do projeto

### Baixando o código

```bash
git clone https://github.com/douglasbolis/ps_pessoa_fastapi_lib.git
cd ps_pessoa_fastapi_lib
```

### Ambiente virtual

```bash
python -m venv .venv
source .venv/bin/activate  # Linux/Mac
.venv\Scripts\activate     # Windows
```

### Instalação dos pacotes

```bash
pip install -r requirements.txt
```

Pode ser que dê problema, então instale os pacotes separadamente.

```bash
pip install sqlmodel "fastapi[standard]" ps_pessoas_fastapi_lib
```

## Publicação da LIB
---

## Execução

```bash
fastapi dev app/main.py # Linux/Mac
fastapi dev .\app\main.py # Windows
```

Acesse a documentação interativa em [http://localhost:8000/docs](http://localhost:8000/docs).

## Estrutura do Projeto

```
.
├── LICENSE                    # Licença do projeto
├── README.md                  # Documentação do projeto
├── app
│   ├── controller             # Rotas e lógica de negócio
│   │   ├── endereco.py
│   │   ├── generic.py
│   │   └── pessoa.py
│   ├── main.py                # Inicialização da aplicação FastAPI
│   ├── model                  # Modelos e DTOs
│   │   ├── dto.py
│   │   └── models.py
│   ├── repository             # Repositórios de acesso a dados
│   │   └── base.py
│   ├── service                # Serviços de negócio
│   │   └── base.py
│   └── util                   # Utilitários e configuração do banco
│       └── database.py
├── app.db                     # Banco de dados em memória
└── requirements.txt           # Pacotes (dependências) para instalação
```

## Licença

Este projeto está sob a licença MIT.
