Open-EO / Open-EO/openeo-python-client
Improve UX of RESTUserDefinedProcess
Open
Nobody has claimed this yet.
feature request
nice-to-have
technical debt
usability
- Dominant language
- Python
- Stars
- 217
- Forks
- 56
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 2
Description
couple of possible improvements to the usability/robustness of the UDP handling methods/classes in python client:
- drop "REST" prefix from
RESTUserDefinedProcess(like we did withRESTJobandRESTCapabilities) - avoid mixing of "store" and "save" verbs in the related methods
- rename
user_defined_process_idargument (in various methods) to something more compact likeidorprocess_id - push for more keyword-only arguments in all related methods (
store,save_user_defined_process, ...)
Contributor guide
No contributing guide indexed for this repository
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
Locate RESTUserDefinedProcess and its related store, save_user_defined_process, and other handling methods, then compare their naming and signatures with RESTJob and RESTCapabilities. Review the uses of user_defined_process_id and the store/save verbs across the related methods. Done means the naming is consistent, the identifier is compact, and the relevant arguments are keyword-only where appropriate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100