Backend REST API for simlog — a SaaS companion app for Microsoft Flight Simulator 2024 pilots. Manage your flight logbook, aircraft checklists and import flight plans directly from SimBrief.
Try it live with the demo account:
- Open the interactive docs.
- Expand
POST /api/auth/login/, click Try it out, and log in with:{ "username": "demo_pilot", "password": "demo_pilot" }- Copy the
accesstoken from the response.- Click the Authorize button (top right), paste the token into the value field, and confirm.
- You can now call any authenticated endpoint — try
GET /api/flights/.
simlog-app (React frontend) → coming soon
- Flight Logbook — log flights with origin, destination, aircraft, duration, score and notes. Filter by origin, destination or aircraft. Search in notes. Paginated responses.
- Checklist Manager — create aircraft profiles with custom checklists and items per flight phase. Track active sessions with completed items.
- SimBrief Integration — fetch your latest flight plan and import it directly into the logbook with one request.
- JWT Authentication — secure endpoints with access and refresh tokens. User profiles with SimBrief pilot ID.
- Stats Dashboard — total flights, hours, airports visited, average score, most flown aircraft and most visited airports.
- Picture Profile — upload with automatic resizing (400px) and JPEG conversion.
The API is fully self-documenting via drf-spectacular, generating an OpenAPI 3 schema and interactive UIs:
| Path | Description |
|---|---|
/api/docs/ |
Swagger UI — browse and test endpoints in the browser (Try it out + Authorize) |
/api/redoc/ |
ReDoc — clean, readable reference documentation |
/api/schema/ |
Raw OpenAPI 3 schema (YAML) |
See the Try it live steps at the top to authenticate with the demo account and test protected endpoints.
| Layer | Technology |
|---|---|
| Language | Python 3.12 |
| Framework | Django 5.x + Django REST Framework |
| Auth | JWT (djangorestframework-simplejwt) |
| Database | PostgreSQL 15 (production) / SQLite (development) |
| Config | python-decouple |
| API Docs | drf-spectacular (OpenAPI 3 / Swagger / ReDoc) |
| Testing | pytest + pytest-django + factory-boy |
| Linting | flake8 |
| Security | bandit |
| CI/CD | GitHub Actions |
| Containers | Docker + docker-compose |
| Deploy/Hosting | Railway |
POST /api/auth/register/ Register a new user
POST /api/auth/login/ Login and get JWT tokens
POST /api/auth/token/refresh/ Refresh access token
GET /api/auth/me/ Get current user profile
PUT /api/auth/me/ Update profile (simbrief_pilot_id)
GET /api/flights/ List flights (paginated, filterable)
POST /api/flights/ Create a flight
GET /api/flights/{id}/ Get flight detail
PUT /api/flights/{id}/ Update a flight
DELETE /api/flights/{id}/ Delete a flight
GET /api/flights/stats/ Get logbook stats
Query parameters:
?origin=EIDW Filter by origin ICAO
?destination=EGLL Filter by destination ICAO
?aircraft=Fenix Filter by aircraft name
?search=Atlantic Search in notes
GET /api/aircraft/ List aircraft
POST /api/aircraft/ Create aircraft
GET /api/aircraft/{id}/ Aircraft detail (with checklists)
PUT /api/aircraft/{id}/ Update aircraft
DELETE /api/aircraft/{id}/ Delete aircraft
GET /api/aircraft/{id}/checklists/ List checklists
POST /api/aircraft/{id}/checklists/ Create checklist
GET /api/checklists/{id}/ Checklist detail (with items)
PUT /api/checklists/{id}/ Update checklist
DELETE /api/checklists/{id}/ Delete checklist
GET /api/checklists/{id}/items/ List items
POST /api/checklists/{id}/items/ Create item
GET /api/items/{id}/ Item detail
PUT /api/items/{id}/ Update item
DELETE /api/items/{id}/ Delete item
POST /api/sessions/ Start a flight session
PATCH /api/sessions/{id}/ Update completed items
GET /api/sessions/{id}/ Get session
GET /api/simbrief/latest/ Fetch latest flight plan
POST /api/simbrief/import/ Import plan into logbook
- Python 3.12+
- Docker Desktop
- Git
git clone https://github.com/emidiovaleretto/simlog-api.git
cd simlog-apicp .env.example .envEdit .env and fill in the required values:
SECRET_KEY=your-secret-key-here-must-be-at-least-32-chars
DEBUG=True
DB_NAME=simlog
DB_USER=simlog_user
DB_PASSWORD=simlog_password
DB_HOST=db # use 'localhost' if running without Docker
DB_PORT=5432docker compose up --buildThe API will be available at http://localhost:8000.
docker compose run --rm -it api python3 manage.py migratePopulate the database with a demo account and sample data (aircraft, checklists, flights):
docker compose run --rm -it api python3 manage.py loaddata fixtures/demo_data.jsonThis creates the demo_pilot account (password: demo_pilot) with realistic sample data, ready to explore via the interactive docs.
# All tests
docker compose run --rm -it api python3 -m pytest tests/ -v
# Specific file
docker compose run --rm -it api python3 -m pytest tests/test_accounts.py -v
# Code style
docker compose run --rm -it api python3 -m flake8 . --max-line-length=120
# Security
docker compose run --rm -it api python3 -m bandit -r . --exclude .venv,migrations -llTest suite: 74 tests across 7 files (plus 1 skipped — social login, in progress).
| File | Tests |
|---|---|
| test_accounts.py | 15 |
| test_checklist.py | 20 |
| test_logbook.py | 17 |
| test_logbook_enhancements.py | 7 |
| test_simbrief.py | 10 |
| test_user_profile.py | 5 |
| test_social_login.py | 1 (skipped) |
simlog-api/
├── .github/
│ └── workflows/
│ └── ci.yml # GitHub Actions CI
├── accounts/ # Auth and user profiles
│ ├── models.py # UserProfile
│ ├── serializers.py
│ ├── views.py # RegisterView, MeView
│ └── urls.py
├── checklist/ # Checklist manager
│ ├── models.py # Aircraft, Checklist, ChecklistItem, FlightSession
│ ├── serializers.py
│ ├── signals.py # Auto-create UserProfile
│ ├── views.py
│ ├── urls.py
│ └── utils.py # Image processing
├── logbook/ # Flight logbook
│ ├── models.py # Flight
│ ├── serializers.py
│ ├── views.py
│ └── urls.py
├── simbrief/ # SimBrief integration
│ ├── services.py # SimBriefService
│ ├── serializers.py
│ ├── views.py
│ └── urls.py
├── core/ # Project config
│ ├── settings/
│ │ ├── base.py
│ │ ├── development.py
│ │ ├── docker.py
│ │ ├── production.py
│ │ └── testing.py
│ └── urls.py # Includes Swagger/ReDoc/schema routes
├── fixtures/
│ └── demo_data.json # Demo account + sample data (loaddata)
├── tests/ # Test suite
│ ├── factories.py
│ ├── test_accounts.py
│ ├── test_checklist.py
│ ├── test_logbook.py
│ ├── test_logbook_enhancements.py
│ ├── test_simbrief.py
│ ├── test_social_login.py
│ └── test_user_profile.py
├── requirements/
│ ├── base.txt
│ ├── development.txt
│ └── production.txt
├── .env.example
├── Dockerfile
├── docker-compose.yml
├── railway.json
├── pytest.ini
├── .flake8
└── manage.py
Settings are split into five files:
base.py— shared across all environmentsdevelopment.py— SQLite, DEBUG=Truedocker.py— PostgreSQL, used by Docker and CIproduction.py— PostgreSQL, DEBUG=Falsetesting.py— SQLite (local), PostgreSQL (CI), DEBUG=True
ICAO codes are always validated and uppercased on origin and destination fields.
Duration is auto-calculated from departure and arrival times on the Flight model.
SimBrief requests use a 10-second timeout to prevent hanging connections.
-
Profile picture placeholder(done) - Social login (Google & GitHub) — in progress
- Cloud storage for media (Cloudinary)
- Health check endpoint + API status page
- React frontend (simlog-app)
See the open issues for a full list of proposed features.
MIT
Made with ☕️🤎 by Emidio Valereto — get in touch!
