blaupause 0.1

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

Blaupause - Python package template

Martin Lang¹ and Marijan Beg¹

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

Description	Badge
Builds
Coverage
Documentation
Binder
License

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

2. Coming soon...

Acknowledgements

• EPSRC Programme grant on Skyrmionics (EP/N032128/1).