# 5G00EV17-3001 Unit testing
An example project for showcasing unit testing.
| Category | Badges |
|:------------:|---|
| **PyPI** | ![Python versions](https://img.shields.io/pypi/pyversions/5G00EV17-3001_unit-testing?logo=python) ![PyPI - Implementation](https://img.shields.io/pypi/implementation/5G00EV17-3001_unit-testing) |
| **Tests** | [![codecov](https://codecov.io/gh/Diapolo10/5G00EV17-3001_unit-testing/branch/main/graph/badge.svg?token=FpaCuVjOAB)](https://codecov.io/gh/Diapolo10/5G00EV17-3001_unit-testing) ![Unit tests](https://github.com/diapolo10/5G00EV17-3001_unit-testing/workflows/Unit%20tests/badge.svg) ![Ruff](https://github.com/diapolo10/5G00EV17-3001_unit-testing/workflows/Ruff/badge.svg) |
| **Activity** | ![GitHub contributors](https://img.shields.io/github/contributors/diapolo10/5G00EV17-3001_unit-testing) ![Last commit](https://img.shields.io/github/last-commit/diapolo10/5G00EV17-3001_unit-testing?logo=github)
| **QA** | [![CodeFactor](https://www.codefactor.io/repository/github/diapolo10/5G00EV17-3001_unit-testing/badge?logo=codefactor)](https://www.codefactor.io/repository/github/diapolo10/5G00EV17-3001_unit-testing) [![Rating](https://img.shields.io/librariesio/sourcerank/pypi/5G00EV17-3001_unit-testing)](https://libraries.io/github/Diapolo10/5G00EV17-3001_unit-testing/sourcerank) |
| **Other** | [![License](https://img.shields.io/github/license/diapolo10/5G00EV17-3001_unit-testing)](https://opensource.org/licenses/MIT) ![Repository size](https://img.shields.io/github/repo-size/diapolo10/5G00EV17-3001_unit-testing?logo=github) ![Code size](https://img.shields.io/github/languages/code-size/diapolo10/5G00EV17-3001_unit-testing?logo=github) ![Lines of code](https://img.shields.io/tokei/lines/github/diapolo10/5G00EV17-3001_unit-testing?logo=github) |
-------------------------------------------------------------------------------
## Description
This project showcases how unit testing works by implementing a very simple
Python library, and adding unit tests to it. The project uses Pytest.
## Getting Started
### Dependencies
The main project has no library dependencies, but the actual unit testing
part relies on several packages listed in
[`pyproject.toml`][pyproject.toml]. But in general, you'll need:
- Python 3.11 or newer
- Poetry
The project is automatically tested on the latest versions of Windows,
Mac OS, and Ubuntu, and it has also been tested on both CPython
and PyPy. Using other implementations or operating systems
may work, but is not guaranteed.
### Installation
Please see the documentation [here][installation].
### Running unit tests
Please see the documentation [here][running unit tests].
## Version history
The project's changelog can be found [here][changelog].
## License
This project is licensed under the MIT license - see the [`LICENSE`][license]-file for details.
## Acknowledgements
Inspiration, code snippets, debugging help, etc.
- My fellow team members
[pyproject.toml]: ./pyproject.toml
[installation]: ./docs/installation.md
[running unit tests]: ./docs/running_unit_tests.md
[changelog]: ./CHANGELOG.md
[license]: ./LICENSE
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/5G00EV17-3001_unit-testing/",
"name": "unit-testing",
"maintainer": "Lari Liuhamo",
"docs_url": null,
"requires_python": ">=3.11.0,<4.0.0",
"maintainer_email": "lari.liuhamo+pypi@gmail.com",
"keywords": "python3",
"author": "Lari Liuhamo",
"author_email": "lari.liuhamo+pypi@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ca/8d/20c3c06ed2d55e2c4d99c39c0306f1b44b160d4da238d2287225315d244d/unit_testing-1.0.4.tar.gz",
"platform": null,
"description": "# 5G00EV17-3001 Unit testing\n\nAn example project for showcasing unit testing.\n\n| Category | Badges |\n|:------------:|---|\n| **PyPI** | ![Python versions](https://img.shields.io/pypi/pyversions/5G00EV17-3001_unit-testing?logo=python) ![PyPI - Implementation](https://img.shields.io/pypi/implementation/5G00EV17-3001_unit-testing) |\n| **Tests** | [![codecov](https://codecov.io/gh/Diapolo10/5G00EV17-3001_unit-testing/branch/main/graph/badge.svg?token=FpaCuVjOAB)](https://codecov.io/gh/Diapolo10/5G00EV17-3001_unit-testing) ![Unit tests](https://github.com/diapolo10/5G00EV17-3001_unit-testing/workflows/Unit%20tests/badge.svg) ![Ruff](https://github.com/diapolo10/5G00EV17-3001_unit-testing/workflows/Ruff/badge.svg) |\n| **Activity** | ![GitHub contributors](https://img.shields.io/github/contributors/diapolo10/5G00EV17-3001_unit-testing) ![Last commit](https://img.shields.io/github/last-commit/diapolo10/5G00EV17-3001_unit-testing?logo=github)\n| **QA** | [![CodeFactor](https://www.codefactor.io/repository/github/diapolo10/5G00EV17-3001_unit-testing/badge?logo=codefactor)](https://www.codefactor.io/repository/github/diapolo10/5G00EV17-3001_unit-testing) [![Rating](https://img.shields.io/librariesio/sourcerank/pypi/5G00EV17-3001_unit-testing)](https://libraries.io/github/Diapolo10/5G00EV17-3001_unit-testing/sourcerank) |\n| **Other** | [![License](https://img.shields.io/github/license/diapolo10/5G00EV17-3001_unit-testing)](https://opensource.org/licenses/MIT) ![Repository size](https://img.shields.io/github/repo-size/diapolo10/5G00EV17-3001_unit-testing?logo=github) ![Code size](https://img.shields.io/github/languages/code-size/diapolo10/5G00EV17-3001_unit-testing?logo=github) ![Lines of code](https://img.shields.io/tokei/lines/github/diapolo10/5G00EV17-3001_unit-testing?logo=github) |\n\n-------------------------------------------------------------------------------\n\n## Description\n\nThis project showcases how unit testing works by implementing a very simple\nPython library, and adding unit tests to it. The project uses Pytest.\n\n## Getting Started\n\n### Dependencies\n\nThe main project has no library dependencies, but the actual unit testing\npart relies on several packages listed in\n[`pyproject.toml`][pyproject.toml]. But in general, you'll need:\n\n- Python 3.11 or newer\n- Poetry\n\nThe project is automatically tested on the latest versions of Windows,\nMac OS, and Ubuntu, and it has also been tested on both CPython\nand PyPy. Using other implementations or operating systems\nmay work, but is not guaranteed.\n\n### Installation\n\nPlease see the documentation [here][installation].\n\n### Running unit tests\n\nPlease see the documentation [here][running unit tests].\n\n## Version history\n\nThe project's changelog can be found [here][changelog].\n\n## License\n\nThis project is licensed under the MIT license - see the [`LICENSE`][license]-file for details.\n\n## Acknowledgements\n\nInspiration, code snippets, debugging help, etc.\n\n- My fellow team members\n\n[pyproject.toml]: ./pyproject.toml\n[installation]: ./docs/installation.md\n[running unit tests]: ./docs/running_unit_tests.md\n[changelog]: ./CHANGELOG.md\n[license]: ./LICENSE\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An example project for showcasing unit testing.",
"version": "1.0.4",
"project_urls": {
"Changelog": "https://github.com/Diapolo10/unit_testing/blob/main/CHANGELOG.md",
"Documentation": "https://github.com/Diapolo10/5G00EV17-3001_unit-testing/tree/main/docs",
"Homepage": "https://pypi.org/project/5G00EV17-3001_unit-testing/",
"Repository": "https://github.com/Diapolo10/5G00EV17-3001_unit-testing",
"Source code": "https://github.com/Diapolo10/unit_testing",
"Tracker": "https://github.com/Diapolo10/unit_testing/issues"
},
"split_keywords": [
"python3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "913c73c228a7ecc38310878a92aee99e075628cc5a3e2fd4132566c521d2e77e",
"md5": "71f662ea27a79c6425d7653bb783b639",
"sha256": "9045029ef520d70a91d869b62f666b2618c9debea8679c1a806d1a65bea05e6b"
},
"downloads": -1,
"filename": "unit_testing-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "71f662ea27a79c6425d7653bb783b639",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11.0,<4.0.0",
"size": 6988,
"upload_time": "2023-11-02T09:10:51",
"upload_time_iso_8601": "2023-11-02T09:10:51.067663Z",
"url": "https://files.pythonhosted.org/packages/91/3c/73c228a7ecc38310878a92aee99e075628cc5a3e2fd4132566c521d2e77e/unit_testing-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ca8d20c3c06ed2d55e2c4d99c39c0306f1b44b160d4da238d2287225315d244d",
"md5": "b6346c7c3b1462f82189274bde5288d3",
"sha256": "fe93cb1d888ef50e329dcc235d4fb04cb72bff9d8817eb4b02eaf480bd2a47be"
},
"downloads": -1,
"filename": "unit_testing-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "b6346c7c3b1462f82189274bde5288d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11.0,<4.0.0",
"size": 6847,
"upload_time": "2023-11-02T09:10:52",
"upload_time_iso_8601": "2023-11-02T09:10:52.535286Z",
"url": "https://files.pythonhosted.org/packages/ca/8d/20c3c06ed2d55e2c4d99c39c0306f1b44b160d4da238d2287225315d244d/unit_testing-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-02 09:10:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Diapolo10",
"github_project": "unit_testing",
"github_not_found": true,
"lcname": "unit-testing"
}