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
DOI DOI

About

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+.

Documentation

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.

Binder

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

Support

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

License

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).

Acknowledgements

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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file blaupause-0.1.3.tar.gz.

File metadata

  • Download URL: blaupause-0.1.3.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/0.0.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for blaupause-0.1.3.tar.gz
Algorithm Hash digest
SHA256 c94feff3366b425117728be799dfa5336c0bea98bc94b1e99ece9664a632dd05
MD5 cd31f738146931908e2e53732b1e54c6
BLAKE2b-256 43411105b12008b9644fb2ca1145b749ceb35512d76350e36a531be2fcc803f8

See more details on using hashes here.

File details

Details for the file blaupause-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: blaupause-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/0.0.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for blaupause-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a2b92015c2ff7c2f6e95b6a3c8c0c3b69ada03c387457571e3b69d9bd59182cc
MD5 3d1ae7b59a9c9e1a25e68b25a4586a33
BLAKE2b-256 ab6fab018d681fd58120f9a40b77facbec16a4cf07b34e8966601bc87c1804fb

See more details on using hashes here.

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