algoesup 0.3.1

Algorithmic essay support library

Algoesup

This small library was written to support the writing of algorithmic essays, but can be used independently of that purpose. The library provides auxiliary functions that make it easier to:

• write unit tests for functions
• measure and plot run-times for best, average and worst case inputs
• use linters and type checkers within Jupyter Notebook environments.

Guidance on how to use the library is here.

To install in the global Python environment, open a terminal or PowerShell, and enter

pip install algoesup

To install in a virtual environment, activate it before entering the command above.

The library supports the ruff and allowed linters, and the pytype type checker. You have to install them explicitly if you want to use them from within a notebook:

pip install ruff allowed pytype

Note that pytype is not available for Windows.

Licence

algoesup is Copyright © 2023–2024 by The Open University, UK. The code is licensed under a BSD 3-clause licence. The documentation is licensed under a Creative Commons Attribution 4.0 International Licence