Skip to main content

📟 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

Metadata

Release files for AprendendoLIB 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for AprendendoLIB 0.1.3
File Size Uploaded
aprendendolib-0.1.3.tar.gz 3.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for AprendendoLIB 0.1.3
File Interpreter ABI Platform
aprendendolib-0.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 7.5 kB

Release files / aprendendolib-0.1.3.tar.gz

Download URL aprendendolib-0.1.3.tar.gz
Size 3.5 kB
Tags Source
SHA-256 checksum
How to use checksums
d7b4ee17ab62da5ab16481ed18e3d76f77d75abf2718ca5db4ff23f89ed5e268
BLAKE2b-256 checksum
How to use checksums
68cd325971ef0f2603366928777b6e70421e77532fcc553e447415bdc6cdcc38
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.1

Release files / aprendendolib-0.1.3-py3-none-any.whl

Download URL aprendendolib-0.1.3-py3-none-any.whl
Size 4.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
231971313aca1104910c9661533c019784dd9ab5109982f5b3f374b6d1f25573
BLAKE2b-256 checksum
How to use checksums
422fd4c6eec50880d5c3ce4a45794dd16daa16f28b0d9d01aee8175e83943520
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.1

Release history Release notifications | RSS feed

This release

0.1.3 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page