Skip to main content

Example package used as a template for setting up Python packages/repositories.

Project description

Blaupause - Python package template

Martin Lang1 and Marijan Beg1

1 Faculty of Engineering and Physical Sciences, University of Southampton, Southampton SO17 1BJ, United Kingdom

Description Badge
Builds Build status
Build Status
Coverage codecov
Documentation Documentation Status
Binder Binder
License License


A sample Python-based package that can be used a tutorial for setting up a project.

Demonstrated are:

  • Testing with pytest/doctests
  • continuous integration
    • Travis
    • Appveyor
    • soon: GitHub actions
  • code coverage
  • docker
  • make files
  • packaging
  • documentation
  • licensing

It is available on Windows, MacOS, and Linux. It requires Python 3.8+.


APIs and tutorials are available in documentation. To access them, use the documentation badge in the table above.

Installation, testing, and upgrade

We recommend installation using conda package manager. Instructions can be found in the documentation.


This package can be used in the cloud via Binder. To access Binder, use the Binder badge in the table above.


If you require support, have questions, want to report a bug, or want to suggest an improvement, please raise an issue in this repository.


Licensed under the BSD 3-Clause "New" or "Revised" License. For details, please refer to the LICENSE file.

How to cite

Please cite this package as:

Martin Lang and Marijan Beg. Blaupause - Python package template. Zenodo. DOI: 10.5281/zenodo.4327500 (2020).


Project details

Download files

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

Source Distribution

blaupause-0.1.3.tar.gz (5.5 kB view hashes)

Uploaded source

Built Distribution

blaupause-0.1.3-py3-none-any.whl (6.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page