stac-utils / stac-utils/stac-fastapi
How to better expose FastAPI internals for downstream modifications?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 324
- Forks
- 126
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 10
Description
As discussed in the stac-utils working group meeting on 26 June, 2023, it can be hard to customize the actual FastAPI data structure underneath our application. @lossyrob mentioned that he hasn't seen anyone do this really well -- each project allows folks to customize routes in their own way, and no one seems to make it really easy. Are there examples of FastAPI-based applications that demonstrate a good (or at least better) structure for allowing FastAPI customizations for an install? If so, we should link them into this issue, and then use them as a basis for a (v3?) refactor.
cc @constantinius @sharkinsspatial
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked STAC Utils working-group discussion and investigate FastAPI-based applications that support downstream customization. Compare how they expose routes and underlying application structures, then document suitable examples and the design direction that could inform a future v3 refactor.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fastapi, python
- Domain
- api, backend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100