# 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 within Jupyter Notebook environments.
Guidance on how to use the library is [here](https://dsa-ou.github.io/algoesup/writing/#code).
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://dsa-ou.github.io/algoesup/",
"name": "algoesup",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "education",
"author": "Michel Wermelinger",
"author_email": "michel.wermelinger@open.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/33/7b/794cac7fc567d8782da68343268462f3537d2287f0d918a4dfef94106c37/algoesup-0.2.0.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 within Jupyter Notebook environments.\n\nGuidance on how to use the library is [here](https://dsa-ou.github.io/algoesup/writing/#code).\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.2.0",
"project_urls": {
"Homepage": "https://dsa-ou.github.io/algoesup/",
"Repository": "https://github.com/dsa-ou/algoesup"
},
"split_keywords": [
"education"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cd14db236001f582063f49aa924ade576c1bc6de5b1d70fe6b0ec168c052d0d0",
"md5": "fdf95c23f4c60410a8bcae88e27538f9",
"sha256": "d074a2912a3d1f50d5742dd2b55bc589cafaaff35b411568ce402c4fcf5eb9bb"
},
"downloads": -1,
"filename": "algoesup-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fdf95c23f4c60410a8bcae88e27538f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 8754,
"upload_time": "2024-03-16T16:44:02",
"upload_time_iso_8601": "2024-03-16T16:44:02.684456Z",
"url": "https://files.pythonhosted.org/packages/cd/14/db236001f582063f49aa924ade576c1bc6de5b1d70fe6b0ec168c052d0d0/algoesup-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "337b794cac7fc567d8782da68343268462f3537d2287f0d918a4dfef94106c37",
"md5": "63855986e09768c4a3b57c6105de8832",
"sha256": "b90f0d55a5df130c3d38ab44a899956087bcb6cf3ac47b6c083f2b1f4531554f"
},
"downloads": -1,
"filename": "algoesup-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "63855986e09768c4a3b57c6105de8832",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 7889,
"upload_time": "2024-03-16T16:44:04",
"upload_time_iso_8601": "2024-03-16T16:44:04.287477Z",
"url": "https://files.pythonhosted.org/packages/33/7b/794cac7fc567d8782da68343268462f3537d2287f0d918a4dfef94106c37/algoesup-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-16 16:44:04",
"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
