Skip to content

Commit 20a66e9

Browse files
committed
Set version to 0.5 final and change status from alpha to beta
1 parent 9efe7e3 commit 20a66e9

3 files changed

Lines changed: 23 additions & 15 deletions

File tree

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,32 @@
55
**undate** is a python library for working with uncertain or partially known dates.
66

77
> [!WARNING]
8-
> This is alpha software and is not yet feature complete! Use with caution and give us feedback.
9-
> Currently `undate` supports parsing and formatting dates in ISO8601, some
10-
portions of EDTF (Extended Date Time Format), and parsing and conversion for dates in Hebrew Anno Mundi and Islamic Hijri calendars
8+
> This is beta software and is not yet feature complete! Use with caution and give us feedback.
9+
> Currently `undate` supports parsing and formatting dates in ISO8601, some
10+
> portions of EDTF (Extended Date Time Format), and parsing and conversion for dates in Hebrew Anno Mundi and Islamic Hijri calendars.
1111
12-
*Undate was initially created as part of a [DH-Tech](https://dh-tech.github.io/) hackathon in November 2022.*
12+
_Undate was initially created as part of a [DH-Tech](https://dh-tech.github.io/) hackathon in November 2022._
1313

14-
* * *
14+
---
1515

1616
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11068867.svg)](https://doi.org/10.5281/zenodo.11068867)
1717
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
1818
[![Documentation Status](https://readthedocs.org/projects/undate-python/badge/?version=latest)](https://undate-python.readthedocs.io/en/latest/?badge=latest)
1919
[![unit tests](https://github.com/dh-tech/undate-python/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/dh-tech/undate-python/actions/workflows/unit_tests.yml)
2020
[![codecov](https://codecov.io/gh/dh-tech/undate-python/branch/main/graph/badge.svg?token=GE7HZE8C9D)](https://codecov.io/gh/dh-tech/undate-python)
2121
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
22+
2223
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
24+
2325
[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](CONTRIBUTORS.md)
26+
2427
<!-- ALL-CONTRIBUTORS-BADGE:END -->
2528

2629
Read [Contributors](CONTRIBUTORS.md) for detailed contribution information.
2730

2831
## Installation
2932

30-
*Recommended*: use pip to install the latest published version from PyPI:
33+
_Recommended_: use pip to install the latest published version from PyPI:
3134

3235
```console
3336
pip install undate
@@ -50,7 +53,7 @@ date formats or even different calendars.
5053

5154
An `undate.Undate` is analogous to python’s builtin `datetime.date`
5255
object, but with support for varying degrees of precision and unknown
53-
information. You can initialize an `Undate` with either strings or
56+
information. You can initialize an `Undate` with either strings or
5457
numbers for whichever parts of the date are known or partially known.
5558
An `Undate` can take an optional label.
5659

@@ -94,7 +97,7 @@ If enough information is known, an `Undate` object can report on its duration:
9497
```
9598

9699
If enough of the date is known and the precision supports it, you can
97-
check if one date falls within another date:
100+
check if one date falls within another date:
98101

99102
```python
100103
>>> november7 = Undate(2000, 11, 7)
@@ -151,7 +154,7 @@ NotImplementedError: Can't compare when one date falls within the other
151154

152155
An `UndateInterval` is a date range between two `Undate` objects.
153156
Intervals can be open-ended, allow for optional labels, and can
154-
calculate duration if enough information is known. `UndateIntervals`
157+
calculate duration if enough information is known. `UndateIntervals`
155158
are inclusive (i.e., a closed interval), and include both the earliest
156159
and latest date as part of the range.
157160

@@ -200,8 +203,8 @@ All `Undate` objects are calendar aware, and date converters include
200203
support for parsing and working with dates from other calendars. The
201204
Gregorian calendar is used by default; currently `undate` supports the
202205
Islamic Hijri calendar and the Hebrew Anno Mundi calendar based on
203-
calendar conversion logic implemented in the
204-
[convertdate](https://convertdate.readthedocs.io/en/latest/) package.
206+
calendar conversion logic implemented in the
207+
[convertdate](https://convertdate.readthedocs.io/en/latest/) package.
205208

206209
Dates are stored with the year, month, day and appropriate precision for
207210
the original calendar; internally, earliest and latest dates are
@@ -227,7 +230,7 @@ comparison across dates from different calendars.
227230
[<Undate '26 Tammuz 4816 Anno Mundi' 4816-04-26 (Hebrew)>, <Undate 'Rajab 495 Hijrī' 0495-07 (Islamic)>, <Undate 2001 (Gregorian)>]
228231
```
229232

230-
* * *
233+
---
231234

232235
For more examples, refer to the code notebooks included in the[examples]
233236
(https://github.com/dh-tech/undate-python/tree/main/examples/) in this

pyproject.toml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@ readme = "README.md"
99
license = { text = "Apache-2" }
1010
requires-python = ">= 3.10"
1111
dynamic = ["version"]
12-
dependencies = ["lark[interegular]", "numpy", "convertdate", "strenum; python_version < '3.11'"]
12+
dependencies = [
13+
"lark[interegular]",
14+
"numpy",
15+
"convertdate",
16+
"strenum; python_version < '3.11'",
17+
]
1318
authors = [
1419
{ name = "Rebecca Sutton Koeser" },
1520
{ name = "Cole Crawford" },
@@ -29,7 +34,7 @@ keywords = [
2934
"digital-humanities",
3035
]
3136
classifiers = [
32-
"Development Status :: 3 - Alpha",
37+
"Development Status :: 4 - Beta",
3338
"Programming Language :: Python :: 3",
3439
"Programming Language :: Python :: 3.10",
3540
"Programming Language :: Python :: 3.11",

src/undate/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
__version__ = "0.5.0.dev0"
1+
__version__ = "0.5.0"
22

33
from undate.date import DatePrecision
44
from undate.undate import Undate, Calendar

0 commit comments

Comments
 (0)