Metadata-Version: 2.1
Name: epiweeks
Version: 2.3.0
Summary: Epidemiological weeks calculation based on the US CDC (MMWR) and ISO week numbering systems
Home-page: https://github.com/dralshehri/epiweeks
Author: Mohammed Alshehri
Author-email: 
License: MIT
Project-URL: Documentation, https://epiweeks.readthedocs.io
Project-URL: Source Code, https://github.com/dralshehri/epiweeks
Keywords: epidemiology,weeks,cdc,mmwr,iso,calendar,surveillance,public-health
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Healthcare Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# 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.
