Describes the design pattern and code structure the author uses for FastAPI web applications. This is only one possible approach, and is not a standard or requirement.
Links:
- Publication URL: https://sqr-072.lsst.io/
- Alternative editions: https://sqr-072.lsst.io/v
- GitHub repository: https://github.com/lsst-sqre/sqr-072
- Build system: https://github.com/lsst-sqre/sqr-072/actions/
You can clone this repository and build the technote locally if your system has Python 3.11 or later:
git clone https://github.com/lsst-sqre/sqr-072
cd sqr-072
make init
make htmlRepeat the make html command to rebuild the technote after making changes. If you need to delete any intermediate files for a clean build, run make clean.
The built technote is located at _build/html/index.html.
This technote is published to https://sqr-072.lsst.io/ whenever you push changes to the main branch on GitHub. When you push changes to a another branch, a preview of the technote is published to https://sqr-072.lsst.io/v.
The main content of this technote is in index.rst (a reStructuredText file). Metadata and configuration is in the technote.toml file. For guidance on creating content and information about specifying metadata and configuration, see the Documenteer documentation: https://documenteer.lsst.io/technotes.