# EpiWeeks
A Python package to calculate epidemiological weeks using the US CDC (MMWR) and
ISO week numbering systems.
## Features
- Support for both the US CDC (MMWR) and ISO week numbering systems.
- Accurate and tested calculations.
- Intuitive, clean, and easy-to-use interface.
- Calculation of the start and end dates of weeks.
- Iteration of year's weeks or week's dates.
- Rich comparison between weeks.
- Logical operations for weeks (addition, subtraction and containment).
- Validation of input data.
- Works on Python 3.8+ with zero dependencies.
- Thoroughly tested with 100% test coverage.
## Installation
To install using `pip`, run:
```shell
pip install epiweeks
```
To install using `conda`, run:
```shell
conda install -c bioconda epiweeks
```
## Basic Usage
```python
from epiweeks import Week, Year
week = Week(2019, 1)
print(week.enddate())
# 2019-01-05
for week in Year(2019).iterweeks():
print(week.enddate())
# 2019-01-05
# 2019-01-12
# ...
# 2019-12-21
# 2019-12-28
```
## Documentation
Please see <https://epiweeks.readthedocs.io> for full documentation of this
package, including background, more usage examples and API reference.
## License
This project is licensed under the terms of the MIT license.
Raw data
{
"_id": null,
"home_page": "https://github.com/dralshehri/epiweeks",
"name": "epiweeks",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "epidemiology,weeks,cdc,mmwr,iso,calendar,surveillance,public-health",
"author": "Mohammed Alshehri",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/33/96/fc0ca16f9046cb9961b8f1a68aaa2a9bc3a4d3df6bad7d6ddd3b7fcee9e4/epiweeks-2.3.0.tar.gz",
"platform": null,
"description": "# EpiWeeks\n\nA Python package to calculate epidemiological weeks using the US CDC (MMWR) and\nISO week numbering systems.\n\n## Features\n\n- Support for both the US CDC (MMWR) and ISO week numbering systems.\n- Accurate and tested calculations.\n- Intuitive, clean, and easy-to-use interface.\n- Calculation of the start and end dates of weeks.\n- Iteration of year's weeks or week's dates.\n- Rich comparison between weeks.\n- Logical operations for weeks (addition, subtraction and containment).\n- Validation of input data.\n- Works on Python 3.8+ with zero dependencies.\n- Thoroughly tested with 100% test coverage.\n\n## Installation\n\nTo install using `pip`, run:\n\n```shell\npip install epiweeks\n```\n\nTo install using `conda`, run:\n\n```shell\nconda install -c bioconda epiweeks\n```\n\n## Basic Usage\n\n```python\nfrom epiweeks import Week, Year\n\nweek = Week(2019, 1)\nprint(week.enddate())\n# 2019-01-05\n\nfor week in Year(2019).iterweeks():\n print(week.enddate())\n# 2019-01-05\n# 2019-01-12\n# ...\n# 2019-12-21\n# 2019-12-28\n```\n\n## Documentation\n\nPlease see <https://epiweeks.readthedocs.io> for full documentation of this\npackage, including background, more usage examples and API reference.\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Epidemiological weeks calculation based on the US CDC (MMWR) and ISO week numbering systems",
"version": "2.3.0",
"project_urls": {
"Documentation": "https://epiweeks.readthedocs.io",
"Homepage": "https://github.com/dralshehri/epiweeks",
"Source Code": "https://github.com/dralshehri/epiweeks"
},
"split_keywords": [
"epidemiology",
"weeks",
"cdc",
"mmwr",
"iso",
"calendar",
"surveillance",
"public-health"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "352286e5006b668ddb2b4c0de7c2df74e2af24672579b4b5468ec8365f235b4f",
"md5": "fe6578183dc13cf96f98e365c1bd56dd",
"sha256": "e60f31f0bb7021cb62d6a366fc90b69798b3f78b2aa929ad78709be9e0cb35a8"
},
"downloads": -1,
"filename": "epiweeks-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fe6578183dc13cf96f98e365c1bd56dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5742,
"upload_time": "2023-12-18T12:12:51",
"upload_time_iso_8601": "2023-12-18T12:12:51.158385Z",
"url": "https://files.pythonhosted.org/packages/35/22/86e5006b668ddb2b4c0de7c2df74e2af24672579b4b5468ec8365f235b4f/epiweeks-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3396fc0ca16f9046cb9961b8f1a68aaa2a9bc3a4d3df6bad7d6ddd3b7fcee9e4",
"md5": "03187366746893d3c044467aed7cfb6f",
"sha256": "3c64ee0b217d0a03f0896fce3c35b73c848c3717790504893cb4eb61b9364bac"
},
"downloads": -1,
"filename": "epiweeks-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "03187366746893d3c044467aed7cfb6f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 18893,
"upload_time": "2023-12-18T12:12:54",
"upload_time_iso_8601": "2023-12-18T12:12:54.288286Z",
"url": "https://files.pythonhosted.org/packages/33/96/fc0ca16f9046cb9961b8f1a68aaa2a9bc3a4d3df6bad7d6ddd3b7fcee9e4/epiweeks-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-18 12:12:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dralshehri",
"github_project": "epiweeks",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "epiweeks"
}
JSON
