Python packaging and release tutorial

This tutorial takes you through all the steps you should put in place to release a python project on PyPi so it can be pip installed. Basically, this tutorial will teach you how to recreate this repository from scratch (including this documentation, how meta!)

There are five main things to consider before releasing your code (apart from obviously the code itself!)

1. Adding a license

2. some example scripts

3. test cases

4. documentation

5. packaging and release.

6. Automation

Full disclosure: once your code is ready and you have added a license, you can skip straight ahead to 5 without considering any of the other steps. However, assuming that the reason you are releasing you code is that you hope that people will actually use it, I highly recomend you include all of these. This tutorial will show you to to quickly set up all these facets.

Prerequisites

• An account on github.com (this is different from our enterprise github)

• An account on test pypi - and you will need to remember your account details!

• A terminal in your OS. On windows, I think pycharm is the easiest option.

• From there, clone this directory into a new environment and do

Contents

Contents:

• Initialise new repository
• Environment set up
  • Linux terminal commands
  • Windows Command Line and PowerShell
• Add supporting files
  • 1. Add a license file
  • 2. Add a .gitignore
  • 3. add requirements.txt
  • 4. Add README.md
• Create demo package
• Write some examples
• Add tests
  • assessing test cover
• Generating documentation
  • Create README.md
  • Code comments and doc strings
  • Detailed documentation and examples
  • Setting up sphinx
• Code Documentation
  • sine_wave_utilities
• Packaging
  • setting up the meta data files
  • Building the package
  • difference between install requires and dev-requirements.txt
• Uploading to PyPi (or test PyPi in this case)
  • uploading future versions
• GitHub workflows for continuous integration
  • Automate tests
  • The green tick of approval
  • Automate docs build

Indices and tables

• Index

• Module Index

• Search Page