rev python api documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Review the existing Python API documentation alongside the CLI documentation and the discussion in issue #974. Map the Python API content to the CLI user stories and paths, keeping async guidance focused and covering bulk versus small-batch ordering. Done means the Python documentation follows a coherent reader flow and explains creating, waiting for, and downloading orders or assets.
Written by the indexing model from the issue text.
Description
Revise python api documentation to match quality of CLI documentation.
Currently the python api documentation is disjointed from a reader perspective, as it was built up piece by piece as code was written. Revise the documentation to match the CLI story flow, using the same user stories and paths whenever possible.
Some specifics:
- on the topic of async, keep it simple and focused on the bit of code needed to get the task done (save 'async best practices' story arc for a later effort)
- when discussing creating, waiting, and downloading an order/asset, be sure to address how bulk ordering may differ from small batch ordering (ref: https://github.com/planetlabs/planet-client-python/issues/974#issuecomment-1640997565_)
- Dominant language
- Python
- Stars
- 299
- Forks
- 100
- Avg merge
- 7d 8h
- Merged PRs (30d)
- 2
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.
More from planetlabs/planet-client-python
-
better-testing
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
planetlabs/planet-client-python#1110 ·
-
proposal
Difficulty 3/5 1-2 days Newbie friendliness 65/100
planetlabs/planet-client-python#1221 ·
-
proposal
Difficulty 3/5 1-2 days Newbie friendliness 57/100
planetlabs/planet-client-python#1214 ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 48/100
planetlabs/planet-client-python#1197 · 1 comment · 1 reaction ·
-
Quota API Openai-claude
planetlabs/planet-client-python#1191 · 1 comment · 1 assignee ·
All issues in planetlabs/planet-client-python
Similar issues
-
sponsored
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Diaoul/subliminal#1382 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
triage/confirmed
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
agentscope-ai/agentscope#2775 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100