Open-EO / Open-EO/openeo-python-client
Documentation: cheat sheet page
Open
Nobody has claimed this yet.
documentation
nice-to-have
usability
- Dominant language
- Python
- Stars
- 217
- Forks
- 56
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 2
Description
Documentation idea: add a cheat sheet page with snippets of essentials:
- connect and auth
- start cube from
load_collection - sync download a cube
- start/track batch job a cube
- download batch job assets
- ...
Single page printout of this would also be handy as promotional material, e.g. in workshops, conferences, ...
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
No documentation file, test, or entry point is identified in the issue. Start by locating the repository's documentation structure and existing Python client examples, then add a single cheat-sheet page covering the listed connection, cube, synchronization, batch-job, and asset-download workflows; done means the snippets are complete and suitable for printing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100