Open-EO / Open-EO/openeo-python-client
Clean up examples
Open
Nobody has claimed this yet.
clean up
good first issue
low hanging fruit
usability
- Dominant language
- Python
- Stars
- 217
- Forks
- 56
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 2
Description
(This was brought up in the telco today)
The examples folder could use some clean up and finetuning, e.g.:
- make sure the script work with latest version of client (and backends)
- make it more clear where to start, e.g.:
- add a README.md
- reduce the number of examples in the root of the examples folder and move more advanced examples to subfolders
- prefix the filenames with number
- harmonize code style and terminology a bit better (e.g. #108, #105)
- avoid fancy dependencies in the base examples
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
Start by reviewing the examples folder and the concerns listed in this issue, then compare the related discussions in #108 and #105. Check the examples against the latest client and backends and identify which examples need clearer organization, terminology, style, and dependencies. Done means the examples are current, consistently organized, and easier to start with.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100