Open-EO / Open-EO/openeo-python-client
Code quality and best practices
Open
Nobody has claimed this yet.
architecture
clean up
collect feedback
documentation
nice-to-have
- Dominant language
- Python
- Stars
- 217
- Forks
- 56
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 2
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.
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
The issue names no files, tests, or entry points. First map the packaging, release configuration, formatting and documentation setup, then clarify which of the proposed improvements is in scope. Done should be a defined, agreed subset implemented with automated checks and updated usage or release documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, python
- Domain
- build-system, documentation, release, tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100