How jooecoodes/cs317-swe works
This repository implements a violation-tracking API for managing employees, violation types, issued records, and analytics, backed by SQLite. The principal workflow is API request → route handler → query operations → persisted records, with schemas shaping request and response data. The tree also contains a frontend and GPS/PT services, but the available README does not describe their roles or wiring; they are shown as separate components without inferred connections. Some routing and data-layer links are supported by excerpts or the SOURCE INDEX; unsampled behavior is not assumed.
Main entry points: main.py App setup · employees.py Employee routes · deps.py Request dependencies · queries.py Domain queries
Components 22
API
- App setup
app/main.py - Employee routes
app/routers/employees.py - Type routes
app/routers/violation_types.py - Violation routes
app/routers/violations.py - Analytics routes
app/routers/analytics.py - Error handlers
app/errors.py - Employee schemas
app/schemas/employee.py - Violation schemas
app/schemas/violation.py - Analytics schemas
app/schemas/analytics.py - Common schemas
app/schemas/common.py - Request dependencies
app/deps.py
Domain and data
- Session lifecycle
app/session.py - Domain queries
queries.py - ORM models
models.py - SQLite database
db.py - Database bootstrap
bootstrap.py
Other services
- GPS service
gps_service/main.py - GPS archiver
gps_service/archiver.py - PT service
pt_service/main.py
Client
- Web frontend
frontend/js/script.js
Other components
- API user
- Web user
Connections 26
- API user → App setup: sends requests
app/main.py - App setup → Employee routes: registers
app/main.py - App setup → Type routes: registers
app/main.py - App setup → Violation routes: registers
app/main.py - App setup → Analytics routes: registers
app/main.py - App setup → Error handlers: registers
app/main.py - Employee routes → Domain queries: calls
app/routers/employees.py - Type routes → Domain queries: calls
app/routers/violation_types.py - Violation routes → Domain queries: calls
app/routers/violations.py - Analytics routes → Domain queries: calls
app/routers/analytics.py - Employee routes → Request dependencies: uses
app/routers/employees.py - Type routes → Request dependencies: uses
app/routers/violation_types.py - Violation routes → Request dependencies: uses
app/routers/violations.py - Analytics routes → Request dependencies: uses
app/routers/analytics.py - Employee routes → Employee schemas: validates and shapes
app/routers/employees.py - Employee routes → Common schemas: shapes pages
app/routers/employees.py - Type routes → Violation schemas: validates and shapes
app/routers/violation_types.py - Violation routes → Violation schemas: validates and shapes
app/routers/violations.py - Analytics routes → Analytics schemas: shapes results
app/routers/analytics.py - Request dependencies → Session lifecycle: depends on
app/deps.py - Session lifecycle → SQLite database: creates sessions
app/session.py - Domain queries → ORM models: queries
queries.py - SQLite database → ORM models: maps tables
- Database bootstrap → ORM models: initializes
bootstrap.py - Database bootstrap → SQLite database: uses
bootstrap.py - Web user → Web frontend: uses