Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Suggestion for project structure/setup improvements

Offen
#355 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
25/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
python
Bereich
build-system, developer-experience, testing, tooling

Rechercherichtung

No files, tests, or entry points are named. Review the current dependency, formatting, test automation, hook, lint, CI, and contribution setup, then define a focused scope and verify that development setup and documented test commands work consistently across the supported Python versions.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

kind/enhancement

I'd like to suggest an (in my opinion) improvement of the project structure/setup and the involved tooling to ease contributions and maintenance.

  1. Use Poetry for dependency management and packaging. Poetry has a number of advantages over plain pip including proper dependency resolution, built-in dependency locking, specification of dev-dependencies, a unified CLI for dependency and package management, virtual env management, etc. Poetry is used in some popular projects including, e.g., isort, diagrams, Rasa among others. I've been using Poetry since v0.12 and believe that it's the best tool available at this point for managing Python projects.
  2. Use code formatters: Black for most of the code and isort for imports. Those two are the de-facto standard code formatters for Python.
  3. Use Tox for test automation, e.g. for running the test suite against all officially supported Python versions (and if applicable against different versions of specific dependencies).
  4. Use pre-commit to run code formatters and linters before a commit to avoid erroneous commits.
  5. Optionally replace Flake8 by Pylint for more sophisticated linting. This is a matter of taste, I personally like Pylint a lot.
  6. Write a contribution guide on how to set up a development environment, how to run the test suite (against multiple Python versions), etc.

If done well, this setup has a single source of truth for all (dev-)dependencies and tool configurations for local development environments, IDEs, pre-commit hooks and CI jobs, integrates with common IDEs like VS Code out of the box (e.g. formatters can be applied when saving a file), and offers reproducible environments and builds for all contributors. I have numerous private projects set up this way, the DX is very smooth.

What do you think? I'd be happy to send a PR.

Vorherrschende Sprache
Python
Sterne
368
Forks
140
Keine gemergten PRs in 30 T.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus python-openapi/openapi-core

Alle Issues in python-openapi/openapi-core

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.