Skip to content
/ pypi-template Public template
generated from jarq6c/miniconda-template

Generic template for creating PyPI compatible Python packages

License

Notifications You must be signed in to change notification settings

jarq6c/pypi-template

Repository files navigation

Generic Python Project

This template can be used as a starting point for building distributable Python packages. It includes a Makefile with targets to setup, run, test, and build a final installable PyPI compatible package. To learn more about packaging in Python see the Python Packaging User Guide.

Build

$ make

Running make in this directory will build the default target "build". The chain of dependencies for the default target includes targets that build a docker image with development dependencies. This target will also run pytest and build, and copy the resulting dist directory with .whl and .tar.gz packages into the currect directory.

Installation

After running build, you can install the default package by running

python -m pip install dist/my_package-0.1.0-py3-none-any.whl

...or, assuming you have an API token and a valid .pypirc file you can upload and install your package from PyPI with

python3 -m twine upload dist/*
python3 -m pip install my_package

See Packaging Python Projects for more details on uploading your package.

Other targets

$ make setup

This target builds the docker image and is required by all other targets.

$ make run

This target runs the CLI application from a docker container indicated in setup.cfg with the arguments specified by ARGUMENTS in the Makefile. This target is mainly a convenience and reference for users. CLI arguments are more easily changed by running this underlying command directly from the command prompt.

$ make tests

This target runs pytest on the code in the image created by "setup" in a docker container.

About

Generic template for creating PyPI compatible Python packages

Resources

License

Stars

Watchers

Forks

Packages

No packages published