Guia de Pacotes Python da pyOpenSci

Damos suporte às ferramentas Python que cientistas precisam para criar fluxos de trabalho de ciência aberta.

Sobre este guia

Este guia vai ajudar você a:

1. Aprender a criar um pacote Python do começo ao fim

2. Entender o ecossistema mais amplo de ferramentas de packaging Python.

3. Navegar e tomar decisões sobre as opções de ferramentas

4. Entender todas as partes envolvidas na criação e manutenção de um pacote Python

Você também encontrará recomendações de boas práticas e listas selecionadas de recursos da comunidade sobre packaging e documentação de pacotes.

Série de tutoriais: Crie um pacote Python

A primeira rodada da nossa série de tutoriais desenvolvida pela comunidade sobre como criar um pacote Python para cientistas está concluída! Participe do processo de revisão da comunidade ou acompanhe o desenvolvimento dos próximos tutoriais em nosso repositório no GitHub aqui.

✿ Tutoriais de Criação de Pacotes ✿

• O que é um pacote Python?

• Crie um pacote Python

• Publique seu pacote no (test) PyPI

• Publique seu pacote no conda-forge

✿ Tutoriais de Metadados de Pacotes ✿

• Como adicionar um arquivo README

• Como adicionar metadados a um arquivo pyproject.toml para publicação no PyPI.

✿ Tutoriais de Ferramentas de Packaging ✿

• Introdução ao Hatch»

• Execute scripts Python usando Hatch

✿ Guias de Referência ✿

• Guia de Referência da Linha de Comando

Packaging Python para Cientistas

Aprenda as melhores práticas de Python packaging. Você também conhecerá o ecossistema vibrante de ferramentas de packaging disponíveis para ajudar nas suas necessidades de packaging Python.

✨ Crie seu pacote ✨

• Estrutura de arquivos do pacote

• Metadados do pacote / pyproject.toml

• Construa o seu pacote (sdist / wheel)

• Declare dependências

• Navegue pelo ecossistema de ferramentas de packaging

• Builds não puros em Python

✨ Publique seu pacote ✨

Aprofunde seu entendimento sobre o ecossistema de packaging PythonAprenda sobre as melhores práticas para:

• Versionamento & release do pacote

• Publique no PyPI & Conda-forge

Documentação

✨ Escreva a documentação ✨

• Crie documentação para seus usuários

• Arquivos principais para incluir no repositório do seu pacote

• Escreva tutoriais para mostrar como seu pacote é usado

✨ Documentação para Desenvolvedores ✨

• Crie documentação para desenvolvedores colaboradores

• Escreva um guia de desenvolvimento

✨ Documentação para a Comunidade ✨

• Escrevendo um arquivo README

• Defina normas com um Código de conduta

• Licencie seu pacote

✨ Publique sua documentação ✨

• Como publicar sua documentação

• Usando Sphinx

• Markdown, MyST e ReST

• Hospede sua documentação no Read The Docs ou GitHub Pages

Testes

✨ Testes para o seu pacote Python ✨

• Introdução a testes

• Escreva testes

• Tipos de testes

✨ Execute seus testes ✨

• Execute testes localmente com Hatch

• Execute testes com nox

• Execute testes em CI

Contribuindo

✨ Estilo de código & formatação ✨

• Estilo de código

✨ Quer contribuir? ✨

Nós recebemos contribuições para este guia. Saiba mais sobre como você pode contribuir.

Contribuindo para o Guia de Empacotamento Python

Um guia criado pela comunidade reddit

Cada página deste guia passa por um extenso processo de revisão pela comunidade. Para garantir que nosso guia seja ao mesmo tempo preciso e amigável para iniciantes, incentivamos revisões de um conjunto diverso de pythonistas e cientistas com uma ampla variedade de habilidades e especializações.

Ver lista de contribuidores

Para quem é este guia

Este guia é para qualquer pessoa interessada em aprender mais sobre packaging em Python. Ele é amigável para iniciantes e fornecerá:

1. Orientação completa, do início ao fim, sobre como criar um pacote Python.

2. Recursos para ajudar você a navegar pelo ecossistema de ferramentas e abordagens de packaging em Python.

3. Uma lista selecionada de recursos para ajudar você a deixar seu pacote bem documentado, utilizável e fácil de manter.

O futuro deste guia pyopensci

Se você tiver ideias sobre pontos que gostaria de ver mais bem esclarecidos neste guia, convidamos você a abrir um issue no GitHub.

Se você tiver dúvidas sobre nosso processo de revisão por pares ou sobre packaging em geral, fique à vontade para usar nossas Discussions no GitHub.

Este guia vivo de packaging em Python é atualizado à medida que as ferramentas e as boas práticas evoluem no ecossistema de packaging Python.Vamos adicionar novos conteúdos ao longo do próximo ano.