Merge branch 'develop' into feature/combined-parser

Author: rlskoeser

.all-contributorsrc

@@ -68,6 +68,25 @@
         "test",
         "doc"
       ]
+    },
+    {
+      "login": "taylor-arnold",
+      "name": "Taylor Arnold",
+      "avatar_url": "https://avatars.githubusercontent.com/u/5752184?v=4",
+      "profile": "http://taylorarnold.org",
+      "contributions": [
+        "review",
+        "ideas"
+      ]
+    },
+    {
+      "login": "rettinghaus",
+      "name": "Klaus Rettinghaus",
+      "avatar_url": "https://avatars.githubusercontent.com/u/7693447?v=4",
+      "profile": "https://github.com/rettinghaus",
+      "contributions": [
+        "maintenance"
+      ]
     }
   ],
   "contributorsPerLine": 7,
@@ -77,5 +96,6 @@
   "repoHost": "https://github.com",
   "projectName": "undate-python",
   "projectOwner": "dh-tech",
-  "badgeTemplate": "![All Contributors](https://img.shields.io/github/all-contributors/dh-tech/undate-python?color=ee8449&style=flat-square)"
+  "badgeTemplate": "![All Contributors](https://img.shields.io/github/all-contributors/dh-tech/undate-python?color=ee8449&style=flat-square)",
+  "commitType": "docs"
 }

.github/workflows/check.yml

@@ -3,6 +3,9 @@ name: Check style + docs + types
 on:
   pull_request:
 
+permissions:
+  contents: read
+
 jobs:
   check:
     runs-on: ubuntu-latest
@@ -12,28 +15,33 @@ jobs:
         working-directory: .
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python 3.12
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.12"
-          cache: 'pip'
-          cache-dependency-path: '**/pyproject.toml'
-      - name: Install package with development dependencies
-        run: pip install -e ".[dev]"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+
+      - name: Install package with check dependencies
+        run: uv sync --extra check
 
       # check with ruff
       - name: Run ruff
-        run: ruff check
+        run: uv run ruff check
 
       # check docs build
       - name: Check that documentation builds with no errors or warnings
-        run: sphinx-build docs docs/_build --fail-on-warning
+        run: uv run sphinx-build docs docs/_build --fail-on-warning
 
       # check types with mypy
       - name: Check types in python src directory; install needed types
-        run: mypy --install-types --non-interactive src
+        run: uv run mypy --install-types --non-interactive src
 
       # use treon to make sure that example notebooks run
       - name: Check jupyter notebooks with treon
-        run: treon
+        run: uv run treon

.github/workflows/python-publish.yml

@@ -21,9 +21,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v5
     - name: Set up Python
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v6
       with:
         python-version: '3.x'
     - name: Install dependencies

.github/workflows/unit_tests.yml

@@ -1,5 +1,9 @@
 name: unit tests
 
+permissions:
+  contents: read
+  id-token: write
+
 on:
   push:
     branches:
@@ -20,32 +24,38 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python: ["3.10", "3.11", "3.12", "3.13"]
     defaults:
       run:
         working-directory: .
 
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v5
+
+      # use github python action instead of uv to take advantage of caching
+      - name: Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python }}
           cache: 'pip'
           cache-dependency-path: '**/pyproject.toml'
+
       - name: Install package with dependencies
         run: pip install -e ".[test]"
 
       # for all versions but the one we use for code coverage, run normally
-      - name: Run unit tests normally
+      - name: Run unit tests without code coverage
         run: pytest
         if: ${{ matrix.python != env.COV_PYTHON_VERSION }}
 
       # run code coverage in one version only
       - name: Run unit tests with code coverage reporting
-        run: pytest --cov=undate
+        run: pytest --cov=.
         if: ${{ matrix.python == env.COV_PYTHON_VERSION }}
-      - name: Upload test coverage to Codecov
-        uses: codecov/codecov-action@v3
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         if: ${{ matrix.python == env.COV_PYTHON_VERSION }}
 

CHANGELOG.md

@@ -1,5 +1,50 @@
 # Change Log
 
+## 0.5.2
+- repr for Undate, UndateInterval, and UnDelta now produce fully-qualified, constructor-style strings with deterministic field ordering.
+- Added Undate.unknown_year property and is_unknown() method to check for fully-unknown year/month/day.
+- bugfix: comparisons (eq, gt, lt) and contains (in) now return False when year is unknown
+- bugfix: month durations for non-Gregorian dates now returns an integer when month length is known
+
+## 0.5.1
+- Correct license identifier in CITATION.cff so it is valid
+
+## 0.5
+
+- New `UnDelta` and `UnInt` classes for uncertain durations
+  - `Undate.duration` now returns either a `Timedelta` or an `UnDelta` if the duration is ambiguous
+- New properties `possible_years` and `representative_years` on `Undate` class, used for calculating durations for uncertain years and months
+- New `weekday` method on class `undate.date.Date`
+- Calendar converter improvements:
+  - Calendar converter classes can optional provide minimum and maximum years for uncertain dates
+  - New calendar methods `days_in_year` and `representative_years`
+  - Hebrew date parser now allows for week days, along with additional month variants
+  - Preliminary Seleucide calendar converter class, based on Hebrew calendar with a year offset
+  - New method `as_calendar` on `Undate` class, to set calendar without doing any conversion
+- Readme examples have been improved and extended
+- New example notebook testing Hebrew, Islamic, and Seleucid date parsing and conversion with Princeton Geniza Project data
+- bugfix: duration for uncertain years previously returned the duration from earliest to latest possible dates in range; now returns an `UnDelta` with the possible durations for the possible years in the given calendar
+
+## 0.4
+
+- Undate is now Calendar aware / Calendar explicit; default is Gregorian
+  - New `BaseCalendarConverter` class, with additional methods required for calendar converters
+  - `HebrewDateConverter`: Parsing and calendar conversion for Hebrew/Anno Mundi
+  - `IslamicDateConverter`: Parsing and calendar conversion for Islamic/Hijri
+  - `GregorianDateConverter`: basic Gregorian calendar logic
+  - `undate.Calendar` class to track `Undate` object calendar, and match with calendar converters
+- BaseDateConverter class now includes nested/descendant subclasses when looking
+  for available converters
+- `Undate.to_undate` method to convert supported date objects to `Undate` (`datetime.date`, `datetime.datetime`, and internal `undate.date.Date` class)
+- `UndateInterval` improvements
+  - Can be initialized with `Undate` objects or any type supported by `Undate.to_undate`
+  - New method for contains (`in`), to determine if another interval or date is contained by an interval
+  - New method `intersection` to determine the overlap between two `UndateInterval` objects
+- EDTF parser : fixed day parsing for some unsupported cases
+- Dropped support for Python 3.9
+- Reorganized examples folder to avoid unnecessary nesting
+  - ISMI data has been updated from older JSON data to examples in RDF (turtle)
+
 ## 0.3.1
 
 Update readthedocs config for current installation
@@ -14,7 +59,7 @@ Update readthedocs config for current installation
   - Support 5+ digit years with leading Y (thanks to numpy.datetime64)
   - Jupyter notebook demonstrating / validating EDTF support
     - Full support for Level 0 Date and Time Interval (no Date and Time support)
-    - Level 1: 
+    - Level 1:
       - Letter-prefixed calendar year
       - Unspecified digit from the right
       - Partial support for extended interval
@@ -28,7 +73,7 @@ Update readthedocs config for current installation
 
 ### numpy impact
 
-Performance differences seem to be negligible, but it does increase payload size.  The virtualenv for installing version 0.2 was 14MB; when installing the newer version with numpy, the virtualenv is 46MB (the numpy folder in site packages is 31MB on its own).
+Performance differences seem to be negligible, but it does increase payload size. The virtualenv for installing version 0.2 was 14MB; when installing the newer version with numpy, the virtualenv is 46MB (the numpy folder in site packages is 31MB on its own).
 
 ## 0.2
 

CITATION.cff

@@ -25,7 +25,7 @@ authors:
   family-names: Casties
   affiliation: Max Planck Institute for the History of Science
   orcid: https://orcid.org/0009-0008-9370-1303
-version: '0.3'
-date-released: 2024-11-18
+version: '0.5'
+date-released: 2025-06-25
 repository-code: https://github.com/dh-tech/undate-python
-license: Apache 2
+license: Apache-2.0

CONTRIBUTORS.md

@@ -19,6 +19,8 @@ We use [All Contributors](https://allcontributors.org/) because we recognize tha
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/robcast"><img src="https://avatars.githubusercontent.com/u/1488847?v=4?s=100" width="100px;" alt="Robert Casties"/><br /><sub><b>Robert Casties</b></sub></a><br /><a href="#data-robcast" title="Data">🔣</a> <a href="#ideas-robcast" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3Arobcast" title="Reviewed Pull Requests">👀</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/jdamerow"><img src="https://avatars.githubusercontent.com/u/8881141?v=4?s=100" width="100px;" alt="Julia Damerow"/><br /><sub><b>Julia Damerow</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/commits?author=jdamerow" title="Code">💻</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3Ajdamerow" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/undate-python/commits?author=jdamerow" title="Tests">⚠️</a> <a href="#eventOrganizing-jdamerow" title="Event Organizing">📋</a> <a href="#ideas-jdamerow" title="Ideas, Planning, & Feedback">🤔</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/maltevogl"><img src="https://avatars.githubusercontent.com/u/20907912?v=4?s=100" width="100px;" alt="Malte Vogl"/><br /><sub><b>Malte Vogl</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/commits?author=maltevogl" title="Code">💻</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3Amaltevogl" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/undate-python/commits?author=maltevogl" title="Tests">⚠️</a> <a href="https://github.com/dh-tech/undate-python/commits?author=maltevogl" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://taylorarnold.org"><img src="https://avatars.githubusercontent.com/u/5752184?v=4?s=100" width="100px;" alt="Taylor Arnold"/><br /><sub><b>Taylor Arnold</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3Ataylor-arnold" title="Reviewed Pull Requests">👀</a> <a href="#ideas-taylor-arnold" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/rettinghaus"><img src="https://avatars.githubusercontent.com/u/7693447?v=4?s=100" width="100px;" alt="Klaus Rettinghaus"/><br /><sub><b>Klaus Rettinghaus</b></sub></a><br /><a href="#maintenance-rettinghaus" title="Maintenance">🚧</a></td>
     </tr>
   </tbody>
   <tfoot>