GitLocker: The Coding Marketplace

Description:

epiweeksbarc 0.0.1

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

Features

Support for both the 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 on all supported Python versions.
Add support for Barc (Week start day from Saturday).

Installation
$ pip install -U epiweeks-barc

Basic Usage
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

Online Tool
The following is a simple online tool that was developed to calculate
epidemiological weeks (CDC system only) using the latest version of
this package:
https://www.dralshehri.com/epiweeks/

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

Contributing
Contributions are welcome! See
CONTRIBUTING.rst
for more info.

Authors
The main author is Mohammed Alshehri —
@dralshehri.

License
This package is distributed under an MIT license.
See LICENSE.

Change Log
2.1.1

Fixed some typos.
Improved documentation.

2.1.0

Changed the parameter method, which sets how the weeks are
numbered, to system for better clarity and intuitive usage.
Updated documentation and unit tests.
Other minor fixes and enhancements.

2.0.0

Dropped support for Python 3.5.
Added fromstring() classmethod to allow constructing the Week object
from a formatted string, for example ‘2019W08’ or ‘201908’.
Added cdcformat() method to return a formatted string like the one used
by US CDC for epi weeks, for example for week 8 of 2019 it returns ‘201908’.
Added daydate() method to return the date of specific weekday for a week.
Changed the optional value ‘WHO’ of the parameter method to ‘ISO’.
Changed the fromdate() classmethod of Week object to accept a date
object as an argument instead of year, month, and day.
Made the Week and Year objects hashable.
Improved rich comparison methods.
Improved input data validation.
Updated and improved documentation examples.
Updated unit tests.
Other minor fixes and enhancements.

1.0.0

First release.