Merge pull request #156 from PainterQubits/develop

Merge develop into main

.github/dependabot.yml

@@ -2,12 +2,24 @@ version: 2
 updates:
   - package-ecosystem: "github-actions"
     directory: "/"
-    schedule:
-      interval: "monthly"
     target-branch: "develop"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "04:00"
+      timezone: "America/Los_Angeles"
+    groups:
+      github-actions:
+        patterns: ["*"]
 
   - package-ecosystem: "pip"
     directory: "/"
-    schedule:
-      interval: "monthly"
     target-branch: "develop"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "04:00"
+      timezone: "America/Los_Angeles"
+    groups:
+      python:
+        update-types: ["minor", "patch"]

.github/workflows/ci.yml

@@ -29,7 +29,7 @@ jobs:
         run: pipx install poetry==${{ env.POETRY_VERSION }}
 
       - name: Set up Python with Poetry cache
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python_version }}
           cache: poetry
@@ -51,7 +51,7 @@ jobs:
 
       - name: Mypy cache
         if: matrix.python_version == env.MAIN_PYTHON_VERSION
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: .mypy_cache
           key: mypy-${{ runner.os }}-python-${{ matrix.python_version }}-${{ github.sha }}

.github/workflows/publish.yml

@@ -5,7 +5,7 @@ on:
     types: [published]
 
 env:
-  POETRY_VERSION: "1.7.0"
+  POETRY_VERSION: "1.7.1"
 
 jobs:
   build:
@@ -21,7 +21,7 @@ jobs:
         run: poetry build
 
       - name: Upload package artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: paramdb-release
           path: dist
@@ -35,7 +35,7 @@ jobs:
     permissions:
       id-token: write
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: paramdb-release
           path: dist

CHANGELOG.md

@@ -7,6 +7,22 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [0.11.0] (Jan 31 2024)
+
+## Added
+
+- `ParamDB.load_commit_entry()` loads a commit entry by ID or the most recent commit.
+- `ParamDB.commit_history_with_data()` to retrieve the commit history with data.
+- `CommitEntryWithData` to store a commit entry containing data.
+
+## Changed
+
+- `ParamDB.commit()` returns a `CommitEntry` instead of the commit ID.
+
+## Removed
+
+- `ParamDB.latest_commit` is replaced by `ParamDB.load_commit_entry()`
+
 ## [0.10.2] (Dec 5 2023)
 
 ### Changed
@@ -137,7 +153,8 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 - Database class `ParamDB` to store parameters in a SQLite file
 - Ability to retrieve the commit history as `CommitEntry` objects
 
-[unreleased]: https://github.com/PainterQubits/paramdb/compare/v0.10.2...develop
+[unreleased]: https://github.com/PainterQubits/paramdb/compare/v0.11.0...develop
+[0.11.0]: https://github.com/PainterQubits/paramdb/releases/tag/v0.11.0
 [0.10.2]: https://github.com/PainterQubits/paramdb/releases/tag/v0.10.2
 [0.10.1]: https://github.com/PainterQubits/paramdb/releases/tag/v0.10.1
 [0.10.0]: https://github.com/PainterQubits/paramdb/releases/tag/v0.10.0

CITATION.cff

@@ -4,6 +4,6 @@ authors:
   - family-names: "Hadley"
     given-names: "Alex"
 title: "ParamDB"
-version: 0.10.2
-date-released: 2023-12-05
+version: 0.11.0
+date-released: 2024-01-31
 url: "https://github.com/PainterQubits/paramdb"

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2023, California Institute of Technology
+Copyright (c) 2023–2024, California Institute of Technology
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

README.md

@@ -1,7 +1,7 @@
 # ParamDB
 
 [![PyPI Latest Release](https://img.shields.io/pypi/v/paramdb)](https://pypi.org/project/paramdb/)
-![PyPI Python Versions](https://img.shields.io/pypi/pyversions/paramdb)
+[![PyPI Python Versions](https://img.shields.io/pypi/pyversions/paramdb)](https://pypi.org/project/paramdb/)
 [![License](https://img.shields.io/pypi/l/paramdb)](https://github.com/PainterQubits/paramdb/blob/main/LICENSE)
 [![CI](https://github.com/PainterQubits/paramdb/actions/workflows/ci.yml/badge.svg)](https://github.com/PainterQubits/paramdb/actions/workflows/ci.yml)
 [![Codecov](https://codecov.io/github/PainterQubits/paramdb/branch/main/graph/badge.svg?token=PQEJWLBTBK)](https://codecov.io/github/PainterQubits/paramdb)

docs/api-reference.md

@@ -23,6 +23,7 @@ All of the following can be imported from `paramdb`.
 ```{eval-rst}
 .. autoclass:: ParamDB
 .. autoclass:: CommitEntry
+.. autoclass:: CommitEntryWithData
 ```
 
 ## Keys

docs/conf.py

@@ -2,9 +2,9 @@
 
 # Project information
 project = "ParamDB"
-copyright = "2023, California Institute of Technology"
+copyright = "2023–2024, California Institute of Technology"
 author = "Alex Hadley"
-release = "0.10.2"
+release = "0.11.0"
 
 # General configuration
 extensions = [

paramdb/__init__.py

@@ -7,7 +7,7 @@
 from paramdb._param_data._dataclasses import Param, Struct
 from paramdb._param_data._collections import ParamList, ParamDict
 from paramdb._param_data._type_mixins import ParentType, RootType
-from paramdb._database import ParamDB, CommitEntry
+from paramdb._database import ParamDB, CommitEntry, CommitEntryWithData
 
 __all__ = [
     "CLASS_NAME_KEY",
@@ -22,4 +22,5 @@
     "RootType",
     "ParamDB",
     "CommitEntry",
+    "CommitEntryWithData",
 ]