Metadata-Version: 2.1
Name: epiweeks
Version: 2.1.4
Summary: Epidemiological weeks calculation based on the US CDC (MMWR) and ISO week numbering systems
Home-page: https://github.com/mhalshehri/epiweeks
Author: Mohammed H Alshehri
Author-email: 
License: MIT
Project-URL: Documentation, https://epiweeks.readthedocs.io
Project-URL: Source Code, https://github.com/mhalshehri/epiweeks
Keywords: epidemiology,weeks,cdc,mmwr,iso,calendar,surveillance,public-health
Platform: UNKNOWN
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: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# epiweeks

<!-- start description -->

A Python package to calculate epidemiological weeks using the US CDC (MMWR) and
ISO week numbering systems.

<!-- end description -->

[![Build Status](https://img.shields.io/github/workflow/status/mhalshehri/epiweeks/Release)][build]
[![Coverage Status](https://img.shields.io/badge/coverage-100%25-success)][coverage]
[![Code Quality](https://img.shields.io/codefactor/grade/github/mhalshehri/epiweeks/main?&label=codefactor)][quality]
[![Docs Status](https://img.shields.io/readthedocs/epiweeks/stable)][docs]
[![PyPI Downloads](https://img.shields.io/pypi/dm/epiweeks?color=blue)][downloads]
[![PyPI Version](https://img.shields.io/pypi/v/epiweeks)][pypi-version]
[![Conda Version](https://img.shields.io/conda/vn/bioconda/epiweeks)][conda-version]
[![Package License](https://img.shields.io/github/license/mhalshehri/epiweeks)][license]

[build]: https://github.com/mhalshehri/epiweeks/actions/workflows/release.yml
[coverage]: https://github.com/mhalshehri/epiweeks/actions/workflows/release.yml
[quality]:
  https://www.codefactor.io/repository/github/mhalshehri/epiweeks/overview/main
[docs]: https://epiweeks.readthedocs.io
[downloads]: https://pypistats.org/packages/epiweeks
[pypi-version]: https://pypi.python.org/pypi/epiweeks
[conda-version]: https://anaconda.org/bioconda/epiweeks
[license]: https://github.com/mhalshehri/epiweeks/blob/main/LICENSE

<!-- start summary -->

## 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.6+ 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
```

<!-- end summary -->

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


