Configuração do Projeto Python

Este guia descreve o passo a passo para configurar o ambiente de desenvolvimento de um projeto Python, incluindo a preparação do ambiente virtual, instalação de dependências e configuração do banco de dados.

---

1. Clonar o Projeto

Primeiro, clone o repositório do projeto a partir do Git:

git clone https://git.oriustecnologia.com/OriusTecnologia/saas_api.git

---

2. Criar o Ambiente Virtual

O uso de um ambiente virtual garante que as bibliotecas instaladas para este projeto não afetem o Python global da sua máquina.

python -m venv venv

---

3. Ativar o Ambiente Virtual

Ative o ambiente virtual antes de instalar as dependências ou executar a aplicação.

venv\Scripts\activate

Observação: Em sistemas Unix (Linux/Mac), o comando pode ser:

source venv/bin/activate

---

4. Instalar Dependências do Sistema

A biblioteca de criptografia utilizada no projeto requer uma extensão da Microsoft para ser instalada. Baixe e instale o Microsoft C++ Build Tools através do link abaixo:

https://visualstudio.microsoft.com/pt-br/visual-cpp-build-tools/

Durante a instalação, selecione o pacote:

Desktop Development With C++

---

5. Instalar as Bibliotecas do Projeto

Com o ambiente virtual ativado, instale as dependências listadas no arquivo requirements.txt:

pip install -r requirements.txt

---

6. Configurar o Banco de Dados

O projeto utiliza um banco Firebird. Edite o arquivo de configuração localizado em:

api/config/database/firebird.json

Exemplo do conteúdo padrão:

{
  "host": "localhost",
  "name": "D:/Orius/Base/CAIAPONIA.FDB",
  "port": 3050,
  "user": "SYSDBA",
  "password": "",
  "charset": "UTF8",
  "pool": {
    "pre_ping": true,
    "size": 5,
    "max_overflow": 10
  }
}

Ajustes Necessários:

• host: Endereço do servidor do banco de dados.
• name: Caminho completo do arquivo .FDB.
• port: Porta do Firebird (padrão: 3050).
• user: Usuário do banco de dados.
• password: Senha do usuário configurado.

---

7. Iniciar a Aplicação

Com o ambiente virtual ativado, execute o comando abaixo para iniciar a aplicação:

uvicorn main:app --reload

Dica: O parâmetro --reload reinicia automaticamente a aplicação sempre que houver alterações no código.

---

8. Testando a Aplicação

Após iniciar a aplicação, abra o navegador e acesse o seguinte endereço:

http://localhost:8000/docs

Você deverá visualizar a interface do Swagger, onde estarão listados todos os endpoints disponíveis da API.

Observação: O Swagger permite testar os endpoints diretamente pelo navegador, sem necessidade de ferramentas externas como Postman ou Insomnia.

---

Resumo dos Comandos

Etapa	Comando
Clonar o projeto	git clone https://git.oriustecnologia.com/OriusTecnologia/saas_api.git
Criar ambiente virtual	python -m venv venv
Ativar ambiente virtual	venv\Scripts\activate (Windows) source venv/bin/activate (Linux/Mac)
Instalar dependências	pip install -r requirements.txt
Iniciar a aplicação	uvicorn main:app --reload