Open-EO / Open-EO/openeo-python-client
Encapsulate `Connection` auth logic better
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 217
- Forks
- 56
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 2
Description
The Connection object has quite a lot of methods related to authentication (basic and OIDC):
_get_auth_config
_get_refresh_token_store
authenticate_basic
authenticate_OIDC
_get_oidc_provider
_get_oidc_provider_and_client_info
_authenticate_oidc
authenticate_oidc_authorization_code
authenticate_oidc_client_credentials
authenticate_oidc_resource_owner_password_credentials
authenticate_oidc_refresh_token
authenticate_oidc_device
This is a bit unfortunate for the documentation: it consumes quite some space, they are all at the top currently, but in practice the least interesting for an EO user.
Also development-wise, it could be cleaner and future-proof to encapsulate all these in, for example, an auth property that groups all these methods
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 locating the Connection implementation and its authentication methods: _get_auth_config, authenticate_basic, and the OIDC helpers listed in the issue. Review how callers and documentation expose these methods before deciding how an auth property should group them. Done means authentication behavior remains available while the Connection interface and generated documentation are less crowded.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, authentication
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100