example_package_samreynoldsmath 0.2.1

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

Python Package Template

Description

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

Prerequisites

• Python 3.11 or later
• Virtual environments
• A PyPi account
• poetry

Usage

Clone the repository

• 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

Make changes

• 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

Build and upload

Clear the dist directory

rm dist/*

Build the package using poetry

poetry build

Publish the package to PyPi using poetry

poetry publish

Install

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

pip install example-package-samreynoldsmath

License

MIT