While the app is running, interactive API documentation can found at the following relative paths: /docs, /redoc.
OpenApiSpec(OAS) formatted in JSON can be found at the following path: /openapi.json
Please read the Developer Setup documentation before developing
for this project to ensure correct environment setup.
The project is structured with the following in mind:
- bin/*
- Some scripts that have proven useful within the CTMS ecosystem
- docs/*
- Documentation to guide others around the project interactions
- ctms/*
- migrations/*
- Alembic migrations that act as a changelog or version control system for implementing DB changes in an ordered fashion
- tests/unit/*
- Test suite using pytest
Below are some files that are worth making note of:
- MAKEFILE
- Enabling commands such as: make {build | lint | setup | start | test | shell | db-only}
- ctms/app.py
- FastAPI handling of HTTP Requests and routing to services
- ctms/bin/acoustic_sync.py
- Background job for synchronizing pending records to Acoustic
- ctms/config.py
- Environment variables are initialized here
- ctms/models.py
- SQLAlchemy models for ORM tool