Develop

.github/workflows/test-python-package.yml

@@ -69,7 +69,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        if [ -f tests/requirements.txt ]; then pip install -r tests/requirements.txt; fi
         for w in ./dist/*.whl; do python -m pip install $w; done
     - name: Lint with flake8
       run: |

.gitignore

@@ -1,4 +1,5 @@
 *.pyc
 .vscode
+.tox
 dist
 !.github

CITATION.cff

@@ -29,5 +29,5 @@ keywords:
   - load
   - loading
 license: Apache-2.0
-version: v1.1.4
+version: 1.1.5
 date-released: '2025-04-01'

ChangeLog.md

@@ -1,5 +1,12 @@
 # [saveable-objects](README.md) Change Log
 
+## Release v1.1.5
+
+- Added the license to the documentation
+- Added link to the GitHub repository to the navigation pane in the documentation
+- Added a version consistency test
+- Added [tox](https://tox.wiki/) support for user testing.
+
 ## Release v1.1.4
 
 - Hid superfluous table of contents in the index page of the User Guide in the documentation;

README.md

@@ -32,5 +32,5 @@ Source code can be found at: [https://github.com/Christopher-K-Long/saveable-obj
 
 ## Version and Changes
 
-The current version is [`1.1.4`](ChangeLog.md#release-114). Please see the [Change Log](ChangeLog.md) for more
+The current version is [`1.1.5`](ChangeLog.md#release-115). Please see the [Change Log](ChangeLog.md) for more
 details.

docs/License.rst

@@ -0,0 +1,4 @@
+License
+=======
+.. include:: ../LICENSE
+    :parser: myst_parser.sphinx_

docs/index.rst

@@ -16,4 +16,7 @@ saveable-objects
 
     user_guide/index
     reference/index
-    ChangeLog.md.rst
+    ChangeLog.md.rst
+    License
+    GitHub <https://github.com/Christopher-K-Long/saveable-objects>
+    PyPI <https://pypi.org/project/saveable-objects/>

docs/user_guide/index.rst

@@ -8,6 +8,7 @@ User Guide
     getting_started
     creating_a_saveableobject
     saving_and_loading
+    running_tests
 
 .. include:: overview.md
     :parser: myst_parser.sphinx_

docs/user_guide/overview.md

@@ -9,6 +9,11 @@
 - [Creating a SaveableObject](creating_a_saveableobject.md)
 - [Saving and loading](saving_and_loading.md)
 
+## Running Tests
+
+ - [Running Tests](running_tests.md)
+
+
 ---
 
 [Next](getting_started.md)

docs/user_guide/running_tests.md

@@ -0,0 +1,32 @@
+# Running Tests
+
+Current status of units tests:
+
+[![Unit Tests](https://github.com/Christopher-K-Long/saveable-objects/actions/workflows/test-python-package.yml/badge.svg)](https://github.com/Christopher-K-Long/saveable-objects/actions/workflows/test-python-package.yml)
+
+You can run the unit tests yourself using [pytest](https://docs.pytest.org) or [tox](https://tox.wiki/).
+
+## Using [tox](https://tox.wiki/)
+
+Once [tox](https://tox.wiki/) is installed you can execute the command
+```bash
+tox
+```
+in from a terminal in the root directory of saveable-objects to execute the tests for your installed python interpreter.
+
+## Using [pytest](https://docs.pytest.org)
+
+To execute the tests with [pytest](https://docs.pytest.org) you will need to set up a python environment with saveable-objects and the packages in `texts/requirements.txt`. For example, you can run
+```bash
+pip install ./
+pip install tests/requirements.txt
+```
+from the root directory of saveable-objects to install all the requirements. Next the tests can be executed with the command
+```bash
+pytest
+```
+from the root directory of saveable-objects.
+
+---
+
+[Previous](saving_and_loading.md)

docs/user_guide/saving_and_loading.md

@@ -221,4 +221,4 @@ we will this time load the state and find `b.z=10`.
 
 This is the end of the tutorial. Now you know everything to use saveable-objects!
 
-[Previous](creating_a_saveableobject.md)
+[Previous](creating_a_saveableobject.md) | [Next](running_tests.md)

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "saveable-objects"
-version = "1.1.4"
+version = "1.1.5"
 authors = [
   { name="Christopher_K._Long", email="ckl45@cam.ac.uk" },
 ]

tests/requirements.txt

@@ -0,0 +1,4 @@
+toml
+pyyaml
+numpy
+cloudpickle

tests/test_version_consistency.py

@@ -0,0 +1,26 @@
+import os
+import toml
+import yaml
+
+PROJECT_DIR = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
+README_FILE = os.path.join(PROJECT_DIR, "README.md")
+TOML_FILE = os.path.join(PROJECT_DIR, "pyproject.toml")
+CITATION_FILE = os.path.join(PROJECT_DIR, "CITATION.cff")
+CHANGELOG_FILE = os.path.join(PROJECT_DIR, "ChangeLog.md")
+
+def test_version_consistency():
+    toml_version = toml.load(TOML_FILE)["project"]["version"]
+    with open(CITATION_FILE, "r") as f:
+        citation_content = yaml.safe_load(f)
+    citation_version = citation_content["version"]
+    assert citation_version == toml_version
+    with open(README_FILE, "r") as f:
+        for line in f.readline():
+            if "`](ChangeLog.md#release-" in line:
+                assert f"[`{toml_version}`](ChangeLog.md#release-{toml_version.replace('.', '')})" in line
+    with open(CHANGELOG_FILE, "r") as f:
+        for line in f.readlines():
+            if line.startswith("## "):
+                assert toml_version in line
+                break
+        else: assert False, "Version not found in CHANGELOG.md"

tox.ini

@@ -0,0 +1,9 @@
+[tox]
+requires =
+    tox>=4
+envlist = 3X
+
+[testenv]
+description = run unit tests
+deps = -rtests/requirements.txt
+commands = pytest tests