HydrologicEngineeringCenter / HydrologicEngineeringCenter/cwms-python
IDEA: Make use of OpenAPI Generated Python for CWMS-Python
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 16
- Forks
- 11
- Avg merge
- 4d 6h
- Merged PRs (30d)
- 8
Description
I propose the following diagram as a means of allowing us to dynamically keep cwms-python up-to-date.
This means as new methods/features are added to cwms-data-api we only need to worry about keeping the methods up-to-date that need custom business logic between the API call and what the enduser sees back.
Cwms-python can wrap all the responses with pandas, math, or any threading we might want for example.
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 cwms-python client and the cwms-data-api interface described in the issue, then inspect the attached diagram for the proposed generation flow. The issue does not name files, tests, or entry points. Done would require an agreed design for generated API code plus the custom business-logic wrappers and a way to keep them synchronized.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100