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

split up openeo.util

Open
#465 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

openeo.util is becoming a "kitchen-sink" of various unrelated utilities and helpers.

Apart from the general rule of thumb to avoid having a "utils" module (because it often turns into such a hodgepodge over time), it is also not clear which functions/helpers are intended for general usage by users and which are just internal helpers.

We should split it up in more thematic submodules and better flag which helpers are just internal.

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 by locating the openeo.util module and its callers, then inventory its unrelated utilities and determine which helpers are intended for public use. Group them into thematic submodules and clearly mark internal helpers; the work is done when the module is no longer a kitchen sink and existing usage remains covered by the project's tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.