CobraPack/service-template
Template
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
12 commits 1 branch 0 tags 289 KiB
Find a file Use this template
Exact
claude-bot-01 8965d3cffa feat: port production patterns from print-estimate-api/print-model-api 
Infrastructure improvements synced from LayersFactory service APIs:

Settings:
- Add LokiSettings (LOKI_* env prefix) for Grafana Loki integration
- Add SystemSettings (SYSTEM_* env prefix) with system user ID/name
- Add SYSTEM_USER_ID and SYSTEM_USER_NAME to core consts
- Add system and loki fields to AppSettings

Logging:
- Add LokiHandler with custom LokiEmitterV1 payload builder
- Add EndpointFilter to suppress healthcheck/metrics noise
- Add init_loki_handler helper
- Add colorlog logger and httpx WARNING-level suppression to app_logger

Docker:
- Multi-stage Dockerfile with --mount=type=secret for private index auth
- Add 4 build targets: webapi, worker, scheduler, migration
- Add start_*.sh entry point scripts

CI/CD:
- development.yaml: add lint-imports step, Docker dev build with layer cache
- build-and-publish.yaml: 4-target release with --secrets and registry cache

Pre-commit:
- Add import-linter hook

Dependencies:
- Add python-logging-loki>=0.3.1

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-03-29 10:55:43 +02:00
.forgejo/workflows feat: port production patterns from print-estimate-api/print-model-api 2026-03-29 10:55:43 +02:00
docs fix some issues and add features 2025-08-23 16:19:58 +00:00
src feat: port production patterns from print-estimate-api/print-model-api 2026-03-29 10:55:43 +02:00
.env.example fix some issues and add features 2025-08-23 16:19:58 +00:00
.gitignore fix some issues and add features 2025-08-23 16:19:58 +00:00
.importlinter fix some issues and add features 2025-08-23 16:19:58 +00:00
.pre-commit-config.yaml feat: port production patterns from print-estimate-api/print-model-api 2026-03-29 10:55:43 +02:00
docker-compose.yaml fix some issues and add features 2025-08-23 16:19:58 +00:00
Dockerfile feat: port production patterns from print-estimate-api/print-model-api 2026-03-29 10:55:43 +02:00
LICENSE Initial commit 2025-07-04 16:53:26 +02:00
logging-granian.json init 2025-07-04 16:54:25 +02:00
mypy.ini fix some issues and add features 2025-08-23 16:19:58 +00:00
prometheus.yml fix some issues and add features 2025-08-23 16:19:58 +00:00
pyproject.toml feat: port production patterns from print-estimate-api/print-model-api 2026-03-29 10:55:43 +02:00
README.md refactor: rename to just service template without fastapi 2025-08-23 15:39:18 +00:00
requirements-dev.txt fix some issues and add features 2025-08-23 16:19:58 +00:00
requirements.txt fix some issues and add features 2025-08-23 16:19:58 +00:00
start_migration.sh feat: port production patterns from print-estimate-api/print-model-api 2026-03-29 10:55:43 +02:00
start_scheduler.sh feat: port production patterns from print-estimate-api/print-model-api 2026-03-29 10:55:43 +02:00
start_webapi.sh feat: port production patterns from print-estimate-api/print-model-api 2026-03-29 10:55:43 +02:00
start_worker.sh feat: port production patterns from print-estimate-api/print-model-api 2026-03-29 10:55:43 +02:00
uv.lock fix some issues and add features 2025-08-23 16:19:58 +00:00

README.md

Service Template

A design template for services with emphasis on asynchronous operations and database integration.

Features

  • Asynchronous handling of HTTP requests (FastAPI).
  • PostgreSQL database support (asyncpg, SQLModel)
  • Job queues (Celery, RabbitMQ)
  • Caching and rate limiting (Redis, slowapi)
  • Configurable settings via .env file
  • Ready integration with database migration tools (Alembic)
  • Extensive logging system (Rich, Granian)
  • Application healthiness (healthchecks)
  • Support for CORS, GZIP, HTTPS redirect, Trusted Hosts

Requirements

  • Python 3.12+
  • Docker (optional, to run in a container)

Installation

  1. Clone the repository: sh git clone <address_repository> cd service-template
  2. Install dependencies:

uv sync

3. Configure the `.env` file according to your needs.
## Run the application
Locally:
```sh
uv run manage-cli api serve

In Docker: ``sh docker build -t service-template . docker run -p 8000:8000 service-template

## Project structure
- `src/service_template/` - main application code
- `src/alembic/` - database migrations
- `tests/` - unit and integration tests
## management commands
All commands are available via CLI:
``sh
uv run manage-cli --help
```.
## Endpoints
- OpenAPI documentation: `/docs`.
- Redoc: `/redoc`
- Healthcheck: `/api/v1/health`.
## Author
Illia Bahlai - i.bahlai@3dcra.eu