https://github.com/michaelcurrin/python-package-quickstart

A simple template for a Python project that can be installed with pip - includes docs and tutorial 🐍 📦
https://github.com/michaelcurrin/python-package-quickstart

base python python-package python3 quickstart scaffold setuptools starter template

Last synced: 4 months ago
JSON representation

A simple template for a Python project that can be installed with pip - includes docs and tutorial 🐍 📦

• Host: GitHub
• URL: https://github.com/michaelcurrin/python-package-quickstart
• Owner: MichaelCurrin
• License: mit
• Created: 2020-05-06T07:05:18.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-23T09:15:21.000Z (over 1 year ago)
• Last Synced: 2025-02-17T07:01:38.575Z (over 1 year ago)
• Topics: base, python, python-package, python3, quickstart, scaffold, setuptools, starter, template
• Language: Python
• Homepage: https://michaelcurrin.github.io/python-package-quickstart/
• Size: 50.8 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Python Package Quickstart 🐍 📦

> A simple template for a Python project that can be installed with pip - includes docs and tutorial

[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/python-package-quickstart?include_prereleases=&sort=semver)](https://github.com/MichaelCurrin/python-package-quickstart/releases/)

[![License](https://img.shields.io/badge/License-MIT-blue)](#license)

[![Made with Python](https://img.shields.io/badge/Made_with-Python-blue?logo=python&logoColor=white)](https://python.org)

## Use this project



  

[![View site GH Pages](https://img.shields.io/badge/GH_Pages-Online_tutorial-blue?style=for-the-badge)](https://michaelcurrin.github.io/python-package-quickstart/)


[![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MichaelCurrin/python-package-quickstart/generate)



## Features

- Template for new Python 3 projects.

- Installable using [pip](https://pypi.org/project/pip/).

    > `pip` is the package installer for Python. You can use `pip` to install packages from the Python Package Index and other indexes.

- Suitable for uploading uploading a package to the public listing on [PyPI](https://pypi.org/).

## Related projects

See also [MichaelCurrin/py-project-template](https://github.com/MichaelCurrin/py-project-template). That isn't installable using `pip` though.

But it does use these:

- Uses Makefile

- Formatting, linting, type checks and unit tests

- GH Actions CI flow

## License

Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).