GitHub - joaopalmeiro/template-python-package: Opinionated Python template for new packages. (original) (raw)

Skip to content

Navigation Menu

• • GitHub Copilot Write better code with AI
  • GitHub Advanced Security Find and fix vulnerabilities
  • Actions Automate any workflow
  • Codespaces Instant dev environments
  • Issues Plan and track work
  • Code Review Manage code changes
  • Discussions Collaborate outside of code
  • Code Search Find more, search less
• Explore
  • Learning Pathways
  • Events & Webinars
  • Ebooks & Whitepapers
  • Customer Stories
  • Partners
  • Executive Insights
• • GitHub Sponsors Fund open source developers
  • The ReadME Project GitHub community articles
• • Enterprise platform AI-powered developer platform
• Pricing

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sign up

template-python-package

Opinionated Python template for new packages.

• Source code
• PyPI package
• Snyk Advisor

Getting Started

1. Go to or create the package folder.
2. Get the template files:

npx degit github:joaopalmeiro/template-python-package

or

npx degit github:joaopalmeiro/template-python-package --force

1. Search for template-python-package and replace it with the package name. Ignore the template repository URL in the NOTES.md file.
2. Search for template_python_package and replace it with the underscored version of the package name.
3. Search for Opinionated Python template for new packages. and replace it with the (short) package description.
4. Search for João Palmeiro and replace it with the author's name.
5. Search for joaopalmeiro@proton.me and replace it with the author's email address.
6. Open the pyproject.toml file and add the package-specific dependencies. See the Dependency configuration and Environment configuration pages in the Hatch documentation for more information (if necessary).
7. Update the Source code link at the top to the package repository link (if necessary).
8. Change GitHub in the Deployment section to GitLab or Codeberg and update the link to the corresponding Tags page (if necessary).
9. Update the Issues and Source fields in the pyproject.toml file with their respective repository-related links (if necessary).
10. Remove hatch-demo/ from the .gitignore file.
11. Delete the TEMPLATE.md file.
12. Delete the Getting Started section.

Development

Install pyenv (if necessary).

pyenv install && pyenv versions

pip install hatch==1.12.0 && hatch --version

hatch config set dirs.env.virtual .hatch

Deployment

echo "v$(hatch version)" | pbcopy

• Commit and push changes.
• Create a tag on GitHub Desktop.
• Check GitHub.
• Check PyPI.