Document best practices for a monorepo containing multiple libraries & runnable apps that consume those libraries

Offen
#177 0 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
python
Bereich
documentation

Rechercherichtung

Beginne mit dem verlinkten WIP-Beispiel-Repository und dem angeforderten Poetry-Monorepo-Layout. Dokumentiere Anleitungen zu virtuellen Umgebungen, pyproject.toml-Dateien, der IDE-Nutzung und dem Veröffentlichen von Bibliotheken, damit bereitgestellte Apps die veröffentlichten Pakete verwenden; behandle das Scaffolding von poetry init als separaten optionalen Umfang.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

I'm finding it extremely difficult to find information on best practices for a poetry monorepo that would house multiple library projects and runnable applications. In particular, information on how to configure an appropriate venv for the monorepo and on how the pyproject.toml files should look, from the root directory down through the libraries & apps, for a good developer experience in their IDE of choice as well as how to properly publish libraries such that builds of the apps correctly use the published libraries when being deployed.

Bonus points for providing an example git monorepo. I've begun one that's broken/incomplete/WIP at https://github.com/matthewadams/python-poetry-monorepo.

Even more bonus points for the poetry CLI to offer scaffolding functionality to initialize a monorepo with best practices via poetry init.

Vorherrschende Sprache
HTML
Sterne
39
Forks
21
Ø Merge
15 Min.
Gemergte PRs (30 T.)
3

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

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-poetry/website

Alle Issues in python-poetry/website

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

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