Full Tutorial

Note

For people who used PH3 before and don’t need all explanations, use the quick guide to remind the key steps.

Package Helper 3 helps you create, develop and maintain a package managed by UV. If you use all the tools presented in this tutorial, things will work this way:

• You create the file structure of your package in less than a minute with the ph3 command.

• You use the IDE PyCharm. It is configured to:

  • Generate the documentation of your package locally, possibly including notebooks.

  • Run the unit tests, including the ones from your docstrings (doctests).

  • Generate a local html page displaying what parts of the package are covered by the unit tests.

• Your project is on GitHub. When you push modifications:

  • GitHub automatically generates the documentation in order to check if it works correctly,

  • If the branch is your default branch (“main”), Github automatically publishes the documentation online,

  • GitHub automatically runs the unit tests on several versions of Python.

  • Codecov displays what parts of the package are covered by the unit tests.

• When you make a release on GitHub, it automatically publishes your package on PyPI. This way, any Python user can install it with pip install.

• Preliminaries: Once and for All
  • 1. Install UV
  • 2. Install Package Helper 3
  • 3. Create Accounts on the Websites
  • 4. Install Git
  • 5. Install Pandoc
  • 6. Install PyCharm
    • Link PyCharm to your GitHub account
• Create Your Package
  • 1. Decide What You Want
  • 2. Execute PH3
  • 3. Install Your Project
    • Install a development environment
    • Install on your default Python distribution
  • 4. Open your Project with PyCharm
    • Run your tests locally
    • Build your documentation locally
  • 5. Go GitHub
    • Check GitHub actions
    • Declare your documentation
    • Link with Codecov
    • Link with PyPI
    • Test on a first commit
  • 6. Time to Code!
• Make a Release
  • 1. Ruff your code
  • 2. Check dependencies in your pyproject.toml
    • Check you didn’t break anything
  • 3. Make it easy to use
  • 4. Bulletproof your tests and documentation
  • 5. Finalize your release
  • 6. Publish