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

Aperta
#177 0 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia con il repository di esempio WIP collegato e il layout del monorepo Poetry richiesto. Documenta le indicazioni per gli ambienti virtuali, i file pyproject.toml, l’uso degli IDE e la pubblicazione delle librerie, in modo che le app distribuite utilizzino i pacchetti pubblicati; considera lo scaffolding di poetry init come un ambito opzionale separato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
HTML
Stelle
39
Fork
21
Merge medio
15m
PR unite (30g)
3

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di python-poetry/website

Tutte le issue di python-poetry/website

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.