Python Package Template

Description

A simple demo of how to structure, use, and publish a Python package.

This is a template repository on GitHub
To use it, click the green Use this template button at the top of the GitHub page
Clone your new repository to your local machine

Change the package name from example_package_samreynoldsmath to your own package name by renaming the directory
Edit the source code as needed
Update the pyproject.toml file to include your own package metadata
Update README.md, CHANGELOG.md, LICENSE, .gitignore, and other files as needed

Clear the dist directory

rm dist/*

Build the package using poetry

poetry build

Publish the package to PyPi using poetry

poetry publish

In a fresh virtual environment, install the package using pip (replace example-package-samreynoldsmath with your package name)

pip install example-package-samreynoldsmath

See documentation for this package on readthedocs.io.

Want to make documentation for your project? Check out the tutorial.

Note

This documentation was built with mkdocs.org.