Repository navigation
Code quality and best practices #294
Description
A couple of notes and ideas on how to improve code quality and adopt best practices
- start using black for code formatting
- lot of interesting pointers in the "Hypermodern Python" blog series and the related cookiecutter template, for example
- the furo for docs looks very nice compared to the default sphinx theme we currently use
- pre-commit with some basic lint/flake8/isort checks
- simplify the release procedure and automate it more (e.g. git tag based automated release)
- switch to
srclayout - add a documentation page with code style recommendations, focused on openEO usage patterns.
Activity
soxofaan commentedon Jul 1, 2022
started with initial code style, best practices doc page in a50f5bb
#294 Cherry pick some minor suggested code style fixes
Issue #294 Start experimenting with pre-commit for linting/code style
soxofaan commentedon Dec 13, 2022
Started playing with pre-commit hook in 01f5256 for linting/code style cleanups
soxofaan commentedon Dec 13, 2022
Another thing to (re)consider: the current lint-and-test action, runs the lint check against all supported python version (3.6 to 3.11), which is a bit overkill. Better just do the linting (e.g. using pre-commit settings) in a separate action on single python version?
Issue #294 whitespace cleanup of README.md and CHANGELOG.md
Issue #294 black setup.py
Issue #294 Introduce .git-blame-ignore-revs
Issue #294 pre-commit --all-files end-of-file-fixer
Issue #294 pre-commit --all-files trailing-whitespace
3 remaining items
Issue #294: added initial ruff config to pyproject.toml
Issue #294 use black profile for isort
Issue #294 isort based import cleanup (openeo src dir)
Issue #294 isort based import cleanup (tests and examples)
Issue #294 some minor code formatting tweaks
Issue #294 black reformat openeo/rest/auth
Issue #294 black reformat openeo/internal
Issue #294 apply isort
Issue #294 blacken code snippets in docs
soxofaan commentedon Mar 25, 2025
did a run of blacken-docs and cherry-picked most improvements in 5e17e18
soxofaan commentedon Apr 16, 2025
Another tool to consider: https://github.com/rstcheck/rstcheck
(as seen in jupytergis https://github.com/geojupyter/jupytergis/blob/19e5a48afe94e1f8671efedf305280aa52f8c947/.pre-commit-config.yaml#L36C11-L40 )
Issue #294 blacken code snippets in docs
chore: clean up unused imports #294
ruff format tests/rest/datacube
ruff format cold test files #294 #870