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

Aberta
#177 0 comentários 2 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

Comece pelo repositório de exemplo WIP vinculado e pelo layout de monorepo do Poetry solicitado. Documente orientações para ambientes virtuais, arquivos pyproject.toml, uso de IDE e publicação de bibliotecas para que os apps implantados usem os pacotes publicados; trate o scaffolding de poetry init como um escopo opcional separado.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
HTML
Estrelas
39
Forks
21
Merge médio
15min
PRs com merge (30d)
3

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de python-poetry/website

Todas as issues de python-poetry/website

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.