# Algoesup
This small library was written to support the writing of
[algorithmic essays](https://dsa-ou.github.io/algoesup),
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](https://dsa-ou.github.io/algoesup/coding/).
To install in the global Python environment, open a terminal or PowerShell, and enter
```bash
pip install algoesup
```
To install in a virtual environment, activate it before entering the command above.
The library supports the [ruff](https://docs.astral.sh/ruff) and
[allowed](https://dsa-ou.github.io/allowed) linters, and the
[pytype](https://google.github.io/pytype) type checker.
You have to install them explicitly if you want to use them from within a notebook:
```bash
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](https://github.com/dsa-ou/algoesup/blob/main/LICENSE).
The documentation is licensed under a
[Creative Commons Attribution 4.0 International Licence](https://creativecommons.org/licenses/by/4.0/)
Raw data
{
"_id": null,
"home_page": "https://github.com/dsa-ou/algoesup/",
"name": "algoesup",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "education",
"author": "Michel Wermelinger",
"author_email": "michel.wermelinger@open.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/e2/0e/5ea4176db37b03b412a4bd45139196761eb1e6d992d54d9a1317bfb9b78b/algoesup-0.3.1.tar.gz",
"platform": null,
"description": "# Algoesup\n\nThis small library was written to support the writing of\n[algorithmic essays](https://dsa-ou.github.io/algoesup),\nbut can be used independently of that purpose.\nThe library provides auxiliary functions that make it easier to:\n - write unit tests for functions\n - measure and plot run-times for best, average and worst case inputs\n - use linters and type checkers within Jupyter Notebook environments.\n\nGuidance on how to use the library is [here](https://dsa-ou.github.io/algoesup/coding/).\n\nTo install in the global Python environment, open a terminal or PowerShell, and enter\n```bash\npip install algoesup\n```\nTo install in a virtual environment, activate it before entering the command above.\n\nThe library supports the [ruff](https://docs.astral.sh/ruff) and\n[allowed](https://dsa-ou.github.io/allowed) linters, and the\n[pytype](https://google.github.io/pytype) type checker.\nYou have to install them explicitly if you want to use them from within a notebook:\n```bash\npip install ruff allowed pytype\n```\nNote that `pytype` is not available for Windows.\n\n## Licence\n\n`algoesup` is Copyright \u00a9 2023\u20132024 by The Open University, UK.\nThe code is licensed under a\n[BSD 3-clause licence](https://github.com/dsa-ou/algoesup/blob/main/LICENSE).\nThe documentation is licensed under a\n[Creative Commons Attribution 4.0 International Licence](https://creativecommons.org/licenses/by/4.0/)",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Algorithmic essay support library",
"version": "0.3.1",
"project_urls": {
"Changelog": "https://github.com/dsa-ou/algoesup/blob/main/CHANGELOG.md",
"Documentation": "https://dsa-ou.github.io/algoesup/library/",
"Homepage": "https://github.com/dsa-ou/algoesup/",
"Repository": "https://github.com/dsa-ou/algoesup/"
},
"split_keywords": [
"education"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8a2f6996f5876736fb1de4795bbe935791e30bd21a46911ba7b21153620ff9a8",
"md5": "748622696d9d538c6c0e739e9bb3ab2f",
"sha256": "0f3e800802536476e6edf2d9ff4b8f6f503bca5ef5916b5a8c7bb9b0ae239a2d"
},
"downloads": -1,
"filename": "algoesup-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "748622696d9d538c6c0e739e9bb3ab2f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 9652,
"upload_time": "2024-08-17T16:48:41",
"upload_time_iso_8601": "2024-08-17T16:48:41.706127Z",
"url": "https://files.pythonhosted.org/packages/8a/2f/6996f5876736fb1de4795bbe935791e30bd21a46911ba7b21153620ff9a8/algoesup-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e20e5ea4176db37b03b412a4bd45139196761eb1e6d992d54d9a1317bfb9b78b",
"md5": "f4ec5be74c7f8e3ebf29994bacbc8176",
"sha256": "d9ab992a98e2d073946803d9d467607436047634c3b5c97eeff1b5ed5dba2bbd"
},
"downloads": -1,
"filename": "algoesup-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "f4ec5be74c7f8e3ebf29994bacbc8176",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 9527,
"upload_time": "2024-08-17T16:48:42",
"upload_time_iso_8601": "2024-08-17T16:48:42.944772Z",
"url": "https://files.pythonhosted.org/packages/e2/0e/5ea4176db37b03b412a4bd45139196761eb1e6d992d54d9a1317bfb9b78b/algoesup-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-17 16:48:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsa-ou",
"github_project": "algoesup",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "algoesup"
}
JSON
