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

Enforce "black" code style

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

Nobody has claimed this yet.

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

Description

related to https://github.com/Open-EO/openeo-python-client/issues/294

This seems to become more an more an issue: this project does not enforce a code formatting style, but in the Python ecosystem there is now a pronounced gravity towards black/ruff format.
A lot of people (myself included) have set up their development environment to automatically apply this code style (or at least partially), but this causes issues with signal/noise ratio in PRs.

I have been reluctant to do a big bang reformat of the code, as this would break all ongoing pull requests,
but lately I've noticed that not fully following the black code style is causing more problems.

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 reading related issue #294 and the repository's existing development and formatting configuration. Define a rollout that enforces the agreed Python formatting style without unnecessarily disrupting ongoing pull requests; done requires the approach and its scope to be documented and applied consistently.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.