Metadata-Version: 2.1
Name: epiweeks
Version: 1.0.0
Summary: Epidemiological weeks by US CDC and WHO calculation methods.
Home-page: UNKNOWN
Author: Mohammed Alshehri
Author-email: 
License: MIT
Project-URL: Source Code, https://github.com/dralshehri/epi-weeks
Project-URL: Documentation, https://epiweeks.readthedocs.io/en/latest
Keywords: epidemiology epi weeks date calendar cdc who
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Requires-Python: >=3.5

Epi Weeks
=========

A Python package to calculate epidemiological weeks using US CDC (MMWR) and
WHO (ISO) calculation methods.

|travis| |codecov| |docs| |supported| |version|

.. |travis|
   image:: https://travis-ci.org/dralshehri/epi-weeks.svg?branch=master
   :alt: Travis-CI Build Status
   :target: https://travis-ci.org/dralshehri/epi-weeks

.. |codecov|
   image:: https://codecov.io/github/dralshehri/epi-weeks/coverage.svg?branch=master
   :alt: Coverage Status
   :target: https://codecov.io/github/dralshehri/epi-weeks

.. |docs|
   image:: https://readthedocs.org/projects/epiweeks/badge/?version=latest
   :alt: Docs Status
   :target: https://epiweeks.readthedocs.io/en/latest

.. |supported|
   image:: https://img.shields.io/pypi/pyversions/epiweeks.svg
   :alt: Supported versions
   :target: https://pypi.python.org/pypi/epiweeks

.. |version|
   image:: https://img.shields.io/pypi/v/epiweeks.svg
   :alt: PyPI Package latest release
   :target: https://pypi.python.org/pypi/epiweeks

Features
--------

- Support for both US CDC (MMWR) and WHO (ISO) calculation methods.
- Fully tested against multiple original references.
- Accurate and reliable calculation.
- Easy and intuitive usage.
- Calculation of start and end dates of week.
- 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.
- More other features...

Installation
------------

.. code-block:: bash

   $ pip install epiweeks

Documentation
-------------

Please see https://epiweeks.readthedocs.io for full documentation of
this package, including usage examples and API reference.

License
-------

This package is distributed under an MIT licence. See ``LICENSE.rst`` file.

Change Log
----------

**1.0.0 (2018-11-28)**

* First release.


