Open-EO / Open-EO/openeo-python-client

Update openeo-auth cli tool and documentation to latest OIDC recommended practices

Open
#303 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation usability
Dominant language
Python
Stars
217
Forks
56
Avg merge
1d 22h
Merged PRs (30d)
2

Description

The OIDC auth docs at https://open-eo.github.io/openeo-python-client/auth.html are quite focused on some practices that are less recommended or deprected now:

  • lot of info on authorization code flow, while probably nobody needs it anymore
  • focus/emphasis should be on device flow
  • openeo-auth oidc-auth does not support new default client and default provider feature: you can not just do openeo-auth oidc-auth openeo.foo if openeo.foo is not yet in config
  • default to using default flow in openeo-auth oidc-auth (and drop auth code support all toghether?)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the OIDC auth documentation at https://open-eo.github.io/openeo-python-client/auth.html and the openeo-auth oidc-auth command. Review how authorization code and device flows, default clients, and default providers are currently presented and handled. Done means the documentation reflects the recommended flow and the CLI supports the requested defaults, with any removed flow behavior decided.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
authentication, cli, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.