Skip to main content

Biblioteca de operações matemáticas básicas em Python.

Project description

📟 FastAPI Calculator + Calculator-Lib

Projeto completo usando Python, FastAPI, Docker, GitHub Packages e GitHub Actions!


📚 O que esse projeto faz?

  • calculator-lib: biblioteca Python de operações matemáticas básicas.
  • fastapi-calculator: serviço FastAPI que usa a calculator-lib para cálculos.
  • CI/CD Automático: testes → build → publicação no GitHub Packages → build da API → publicação da imagem Docker.

⚙️ Fluxo de CI/CD (GitHub Actions)

  1. Testa a biblioteca calculator-lib
  2. Publica a biblioteca no GitHub Packages
  3. Testa o serviço fastapi-calculator
  4. Builda e publica o container Docker no GitHub Container Registry (ghcr.io)

✅ Cada etapa depende da anterior para garantir a qualidade!


📦 Instalação local

📚 1. Instalar a biblioteca calculator-lib

Se publicada no PyPI ou GitHub Packages:

pip install calculator-lib

Se localmente:

python -m pip install .

🚀 2. Rodar o serviço FastAPI

Instale as dependências:

python -m pip install -r requirements.txt

Suba a API:

uvicorn app.main:app --reload

Acesse: 👉 http://localhost:8000/docs


🐳 Rodar usando Docker e Docker Compose

📋 Buildar e rodar

make docker-build     # Builda a imagem usando docker compose
make docker-up        # Sobe o serviço

ou em modo detached:

make docker-up-detached

Para derrubar:

make docker-down

Para limpar tudo (imagens, volumes):

make docker-clean

🛠️ Makefile: Comandos úteis

Comando Ação
make install Instalar dependências da API
make install-lib Instalar calculator-lib
make install-dev Instalar ferramentas de desenvolvimento
make test-lib Testar a biblioteca
make test-app Testar a API
make build-lib Buildar lib tradicional (setup.py)
make build-modern Buildar lib moderno (python -m build)
make publish-lib Publicar lib (quando configurado)
make docker-build Buildar imagem Docker via Compose
make docker-up Subir serviço Docker
make docker-up-detached Subir serviço em background
make docker-down Derrubar containers
make docker-clean Limpar containers, imagens, volumes

📚 Publicação manual da calculator-lib

🛠️ Passo a passo

  1. Instalar ferramentas de build:
make install-dev

Ou diretamente:

python -m pip install build twine wheel
  1. Buildar a lib:
make build-modern

ou

python -m build

Isso vai gerar a pasta dist/ contendo .tar.gz e .whl.

  1. Publicar no GitHub Packages (ou PyPI)

Se configurado para GitHub Packages:

python -m twine upload dist/*

Lembre-se de configurar seu .pypirc e usar o GITHUB_TOKEN ou TWINE_USERNAME/TWINE_PASSWORD.


📂 Estrutura do Projeto

fastapi-calculator/
├── app/
│   ├── main.py
│   ├── models.py
├── calculator_lib/
│   ├── __init__.py
│   └── operations.py
├── tests/
│   └── test_main.py
├── tests_lib/
│   └── test_operations.py
├── docker-compose.yml
├── Dockerfile
├── Makefile
├── README.md
├── setup.py
├── pyproject.toml
└── .github/
    └── workflows/
        └── test-and-deploy.yml

testando a lib

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

calculadora_saraiva_lib-0.1.2.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

calculadora_saraiva_lib-0.1.2-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

Details for the file calculadora_saraiva_lib-0.1.2.tar.gz.

File metadata

  • Download URL: calculadora_saraiva_lib-0.1.2.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.1

File hashes

Hashes for calculadora_saraiva_lib-0.1.2.tar.gz
Algorithm Hash digest
SHA256 f378788dc17c7e76c2b56b73ef51a3ef5114f8fb57c396353b8a910e103d66ac
MD5 b47ab4e82e590b67f3bfe9f8e735620b
BLAKE2b-256 35fa08b9d8f1f14c37b3f9c7d975fd4f6e3b0f36adbf12f2632ba0e99a3087a3

See more details on using hashes here.

File details

Details for the file calculadora_saraiva_lib-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for calculadora_saraiva_lib-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7609a8f2ddb95469bd35320044d70c9dbbbe66fb72efee2a5178285009fd10fd
MD5 71560793f086b41103a57440b6638a51
BLAKE2b-256 b7fd11b99d2e871f063bed7448847f8d103f63672e798a4bf9972488f3ae246b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page