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

Abierto
#177 0 comentarios 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python

Línea de trabajo

Comienza con el repositorio de ejemplo WIP enlazado y la estructura de monorepo de Poetry solicitada. Documenta las directrices para entornos virtuales, archivos pyproject.toml, el uso de IDE y la publicación de bibliotecas para que las aplicaciones desplegadas utilicen los paquetes publicados; trata el scaffolding de poetry init como un alcance opcional separado.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
HTML
Estrellas
39
Forks
21
Merge medio
15 min
PR fusionados (30 d)
3

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de python-poetry/website

Todos los issues de python-poetry/website

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.