Merge pull request #84 from dh-tech/experiment/numpy-datetime64

Use numpy datetime64  instead of datetime.date #77

.github/workflows/check.yml

@@ -23,9 +23,9 @@ jobs:
         run: pip install -e ".[dev]"
         if: steps.python-cache.outputs.cache-hit != 'true'
 
-      # check code style
-      - name: Run black
-        run: black src --check --diff
+      # check with ruff
+      - name: Run ruff
+        run: ruff check
 
       # check docs
       - name: Check that documentation can be built

.github/workflows/unit_tests.yml

@@ -11,7 +11,7 @@ on:
 
 env:
   # python version used to calculate and submit code coverage
-  COV_PYTHON_VERSION: "3.11"
+  COV_PYTHON_VERSION: "3.12"
 
 jobs:
   python-unit:

.pre-commit-config.yaml

@@ -1,9 +1,11 @@
 files: \.py
 repos:
-  - repo: https://github.com/psf/black
-    rev: 22.10.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.4
     hooks:
-      - id: black
+      - id: ruff
+        args: [ --select, I, --fix, --exit-non-zero-on-fix ]
+      - id: ruff-format
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.3.0
     hooks:
@@ -14,7 +16,7 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.11.2
+    rev: v1.13.0
     hooks:
       - id: mypy
-        additional_dependencies: [types-python-dateutil]
+        additional_dependencies: [numpy]

.pythonversion

@@ -0,0 +1 @@
+Python 3.12.7

CONTRIBUTORS.md

@@ -46,5 +46,6 @@ We use [All Contributors](https://allcontributors.org/) because we recognize tha
 
 ### Related blog posts
 
-- [by Rebecca Sutton Koeser](#blog-rlskoeser)
+(blog-rlskoeser)=
+#### [by Rebecca Sutton Koeser](#blog-rlskoeser)
   - [Join me for a DHTech hackathon? It’s an un-date!](https://dh-tech.github.io/blog/2023-02-09-hackathon-summary/) 2023-02-09 on DHTech blog 

DEVELOPER_NOTES.md

@@ -31,10 +31,12 @@ If you cannot or prefer not to install git flow, you can do the equivalent manua
 
 ### Create a Python virtual environment
 
-Use a recent version of python 3. We highly recommend using a python virtualenv, e.g.
+Use a recent version of python 3 (we recommend 3.12).  If you use [pyenv](https://github.com/pyenv/pyenv), run `pyenv install` to get the current recommended python version for development (specified in `.pythonversion`).
+
+We highly recommend using a python virtualenv to isolate dependencies, e.g.
 ```
-python3 -m venv undate
-source undate/bin/activate
+python3 -m venv .venv
+source .venv/bin/activate
 ```
 
 ### Install local version of undate with development python dependencies
@@ -47,12 +49,12 @@ pip install -e ".[dev]"
 
 ### Install pre-commit hooks
 
+We use [pre-commit](https://pre-commit.com/) for automated checks and consistent formatting.  If you're planning to contribute, please install these when you set up your local development.
+
 ```sh
 pre-commit install
 ```
 
-We use [pre-commit](https://pre-commit.com/) for automated checks and consistent formatting.  If you're planning to contribute, please install these when you set up your local development.
-
 ## Tests, documentation, and other checks
 
 ### Running unit tests
@@ -65,7 +67,7 @@ To test cases by method name, use `-k`: `pytest -k test_str`
 
 ### Check python types
 
-Python typing is currently enforced on pull requests as part of a GitHub Actions Continuous Integration check using `mypy`.
+Python typing is currently enforced on pull requests as part of a GitHub Actions Continuous Integration check using `mypy` and via pre-commit hook.
 
 To check types locally:
 1. Install the necessary typing libraries (first run only):

README.md

@@ -16,7 +16,7 @@ It was initially created as part of a [DH-Tech](https://dh-tech.github.io/) hack
 [![Documentation Status](https://readthedocs.org/projects/undate-python/badge/?version=latest)](https://undate-python.readthedocs.io/en/latest/?badge=latest)
 [![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)
 [![codecov](https://codecov.io/gh/dh-tech/undate-python/branch/main/graph/badge.svg?token=GE7HZE8C9D)](https://codecov.io/gh/dh-tech/undate-python)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![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)
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](CONTRIBUTORS.md)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->

docs/conf.py

@@ -86,4 +86,4 @@
 }
 
 # turn on relative links; make sure both github and sphinx links work
-m2r_parse_relative_links = True
+myst_enable_extensions = ["linkify"]