Open-EO / Open-EO/openeo-python-client
Promote usage of "connection" and deprecate "session"
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 217
- Forks
- 56
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 2
Description
Currently in the python client implementation and examples, the terms "session" and "connection" are used interchangeably.
I think it would improve usability and reduce confusion if only one of them would be used.
Some arguments to favour "connection" and deprecate "session"
- the openeo client guidelines use "connection", not "session"
- "connection" is pretty explicit about being connected to a particular backend and acts as the starting point to interact with that backend. The term "session" is more general and could (also) be a container for non-backend related settings (e.g. where data files should be downloaded to, where user credentials are stored, ...). And maybe in longer term, a session could also be about maintaining multiple connections to possibly different backends. Also see sqlalchemy for example where "session" is a higher level, more encompassing thing than "connection".
- the Python DB API (PEP249) uses the term "connection"
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
Review the Python client implementation and examples for uses of “session” and “connection”, then compare the terminology with the linked openEO client guidelines and PEP 249. The scope and compatibility implications are not defined; done should mean a decided, consistent terminology across the affected client surface and examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100