Metadata-Version: 2.1
Name: mp-yearmonth
Version: 0.2.0
Summary: A year-month datatype for Python.
Author: Ramon Torres
Author-email: ramon@macropoetry.com
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Typed
Project-URL: homepage, https://github.com/raymondjavaxx/mp-yearmonth
Project-URL: tracker, https://github.com/raymondjavaxx/mp-yearmonth/issues
Description-Content-Type: text/markdown

# mp-yearmonth

A year-month datatype for Python.

## Installation

```bash
pip install mp-yearmonth
```

## Usage

```python
from mp_yearmonth import YearMonth

ym = YearMonth(2019, 1)
print(ym) # 2019-01
```

Parsing ISO 8601 strings:

```python
ym = YearMonth.parse("2019-01")

print(ym.year) # 2019
print(ym.month) # 1
```

Comparisons:

```python
ym1 = YearMonth(2019, 1)
ym2 = YearMonth(2019, 2)

print(ym1 < ym2) # True
```

Addition:

```python
ym = YearMonth(2019, 1)
ym += 1

print(ym) # 2019-02
```

Range:

```python
ym1 = YearMonth(2019, 1)
ym2 = YearMonth(2019, 3)

for ym in YearMonth.range(ym1, ym2):
    print(ym) # 2019-01, 2019-02, 2019-03
```

## License

mp-yearmonth is licensed under the MIT license. See [LICENSE](LICENSE) for details.

