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

Ouverte
#177 0 commentaires 2 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
python
Domaine
documentation

Piste de recherche

Commencez par le dépôt d’exemple WIP lié et la structure de monorepo Poetry demandée. Documentez les indications concernant les environnements virtuels, les fichiers pyproject.toml, l’utilisation des IDE et la publication des bibliothèques afin que les applications déployées utilisent les paquets publiés ; traitez le scaffolding de poetry init comme un périmètre optionnel distinct.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
HTML
Étoiles
39
Forks
21
Merge moyen
15 min
PR mergées (30 j)
3

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de python-poetry/website

Toutes les issues de python-poetry/website

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.