Skip to main content

A python package template

Project description

Python Package Template

Latest Release latest release
latest release
latest release
Package Status status
License license
Build Status gitlab pipeline status
Coverage coverage
Conda conda downloads
Documentation readthedocs documentation

This is an opinionated attempt to document how I deploy a python application with documentation, testing, pypi, and continuous deployment. This project will be updated as I change my python development practices. Number one this is a learning experience.


Gitlab will be used for the continuous deployment. It is a great project that is open source and comes with many nice features not available for Github. You should consider it! Features used:

If you would like a custom domain setup with gitlab pages for the documentation you will need to use cloudflare. I have a blog written on how to do this or you can look at the gitlab cloudflare documentation.


This project is a python package itself and full documentation is available on readthedocs. Each of the steps below includes a link to the section in the documentation.

  1. setup a bare python package with git repo (,, .gitignore, <package>)
  2. setup pypi deployment with git tags vX.X.X
  3. setup testing on each commit with pytest
  4. setup documentation with sphinx on readthedocs and self hosted




All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome.

The goal of this project is to in an opinionated way guide modern python packaging development for myself.



Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pypkgtemp, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size pypkgtemp-1.2.0-py3-none-any.whl (6.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pypkgtemp-1.2.0.tar.gz (4.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page