stac-utils / stac-utils/stac-fastapi
Add examples to the docs?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 324
- Forks
- 126
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 10
Description
Hello all, thank you very much for all the work on stac-fastapi
I was wondering if there are any small example apps that I could reference. In the docs I see documentation for the Python API, but not any examples of how to incorporate it in an existing fastapi project. I have an existing fast api app and I would like to incorperate stac-fastapi but I am a bit unsure best practices for setting up the project and various configuration settings.
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 by reviewing the existing Python API documentation and the repository's current FastAPI guidance. Add small example-app documentation showing how to incorporate stac-fastapi into an existing FastAPI project and explain relevant configuration settings and setup practices. Done means a newcomer can follow the examples without having to infer the integration approach.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fastapi, python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 48/100