invenio-subjects-mesh-lite 2024.3.6__tar.gz → 2025.1.15.2__tar.gz

{invenio_subjects_mesh_lite-2024.3.6 → invenio_subjects_mesh_lite-2025.1.15.2}/CHANGES.md

@@ -1,5 +1,14 @@
 # Changes
 
+Version 2025.1.15.2 (released 2025-07-15)
+
+- Compatible with InvenioRDM v13
+- Switch versioning pattern
+
+Version 2025.1.15 (released 2025-01-15)
+
+- MeSH 2025
+
 Version 2024.3.6 (released 2024-08-09)
 
 - make compatible with InvenioRDM v12

{invenio_subjects_mesh_lite-2024.3.6/invenio_subjects_mesh_lite.egg-info → invenio_subjects_mesh_lite-2025.1.15.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: invenio-subjects-mesh-lite
-Version: 2024.3.6
+Version: 2025.1.15.2
 Summary: MeSH subject terms without qualifiers
 Author-email: Northwestern University <DL_FSM_GDS@e.northwestern.edu>
 License: MIT License
@@ -38,21 +38,33 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: galter-subjects-utils<2.0,>=0.4.2
+Requires-Dist: galter-subjects-utils<2.0,>=0.7.0
 Provides-Extra: dev
 Requires-Dist: check-manifest>=0.49; extra == "dev"
 Requires-Dist: invenio-search[opensearch2]<3.0,>=2.1.0; extra == "dev"
 Requires-Dist: invoke<3.0,>=2.2; extra == "dev"
 Requires-Dist: pyyaml>=5.4.1; extra == "dev"
 Requires-Dist: pytest-invenio<3.0.0,>=2.1.1; extra == "dev"
+Provides-Extra: dev-pre
+Requires-Dist: check-manifest>=0.49; extra == "dev-pre"
+Requires-Dist: invenio-search[opensearch2]<4.0.0,>=3.0.0; extra == "dev-pre"
+Requires-Dist: invoke<3.0,>=2.2; extra == "dev-pre"
+Requires-Dist: pyyaml>=5.4.1; extra == "dev-pre"
+Requires-Dist: pytest-invenio<4.0.0,>=3.3.0; extra == "dev-pre"
+Dynamic: license-file
 
 # invenio-subjects-mesh-lite
 
 *MeSH topical subject terms without qualifiers for InvenioRDM*
 
+<a href="https://pypi.org/project/invenio-subjects-mesh-lite/">
+  <img src="https://img.shields.io/pypi/v/invenio-subjects-mesh-lite.svg">
+</a>
+
 Install this extension to get Medical Subject Headings topics without qualifiers into your instance.
 
 If you are looking for a larger MeSH vocabulary with qualifiers, use
@@ -75,21 +87,40 @@ This will add it to your Pipfile.
 
 ## Versions
 
-This repository follows [calendar versioning](https://calver.org/) for year and month:
+**From 2025.1.15.2 onwards**
 
-`2021.06.18` is both a valid semantic version and an indicator of the year-month corresponding to the loaded MeSH terms.
-`18` here is a patch number (not a day).
+This package follows the following format for versions: `YYYY.mm.dd.patch` where
+
+- `YYYY.mm.dd` is the date of retrieval of the MeSH terms with `mm` and `dd` NOT being 0-prefixed.
+- `patch` is the patch number (0-indexed) so that multiple releases can be done on the same day (bug/security fixes) and non-subject related releases can be done as well.
+
+This follows [calendar versioning](https://calver.org/) (for year, month, and day) and adds a patch number at the end. The package is typically updated on a quarterly basis. The following are illustrative (fictitious) examples of how to understand the versioning of this distribution package:
+
+| Last MeSH update included | patch number | version of this project |
+| ------------------------- | ------------ | ----------------------- |
+| 2025-06-31                | 2            | 2025.6.31.2             |
+| 2025-12-01                | 0            | 2025.12.1.0             |
+
+**Prior to 2025.1.15.2**
+
+This repository follows [calendar versioning](https://calver.org/) for year and month. It does a "best effort" attempt at tracking the MeSH updates in an *up-to-and-including* version date manner. The following are illustrative cases of how to understand the versioning of this distribution package:
+
+| Last MeSH update included | version of this project | date of release of this project |
+| ------------------------- | ----------------------- | ------------------------------- |
+| 2024-01-31                | 2024.1.X                | any time after 2024-01-31       |
+| 2023-12-31                | 2023.12.X               | any time after 2023-12-31       |
 
-So far the package is compatible with InvenioRDM 9.1+'s subjects "ABI". If there is a breaking change, a compatibility
-table will be provided to indicate version cross-compatibility.
+
+`2021.06.18` is both a valid semantic version and an indicator of the year-month corresponding to the loaded terms.
+`18` here is a patch number (not a day).
 
 ## Usage
 
-There are 2 types of users for this package. Instance administrators and package maintainers.
+There are 2 types of users for this package. Instance operators and package maintainers.
 
-### Instance administrators
+### Instance operators
 
-For instance administrators, after you have installed the extension as per the steps above, you will want to reload your instance's fixtures: `pipenv run invenio rdm-records fixtures`. This will install the new terms in your instance.
+For instance operators, after you have installed the extension as per the steps above, you will want to reload your instance's fixtures: `pipenv run invenio rdm-records fixtures`. This will install the new terms in your instance.
 
 Alternatively, or if you want to update your already loaded subjects to a new listing (e.g. from one year's list to another), you can update your instance's MeSH subjects as per below. Updating subjects this way takes care of everything for you: the subjects themselves and the records/drafts using those subjects. **WARNING** This operation can _remove_ subjects.
 
@@ -127,6 +158,8 @@ Once you have it installed, you can run the following commands in the isolated v
 (venv) invenio galter_subjects mesh file -d /path/to/downloads/storage/ -y YEAR -f topic -o invenio_subjects_mesh_lite/vocabularies/subjects_mesh.csv
 ```
 
+Sorting the resulting csv is a nice touch for humans to better parse the changes between versions.
+
 When you are happy with the list, bump the version in `pyproject.toml` and release it.
 
 
@@ -150,6 +183,17 @@ Run tests:
 pipenv run inv test
 ```
 
+Test compatibility with the pre-release version of InvenioRDM (invenio-app-rdm):
+
+```bash
+# Step 1 - install the pre-release dependencies
+(venv) pip install --pre -e .[dev_pre]
+# Step 2 - Run the pre-release tests
+(venv) inv test
+# if using uv run:
+uv run --extra dev_pre --prerelease=allow inv test
+```
+
 Check manifest:
 
 ```bash

{invenio_subjects_mesh_lite-2024.3.6 → invenio_subjects_mesh_lite-2025.1.15.2}/README.md

@@ -2,6 +2,10 @@
 
 *MeSH topical subject terms without qualifiers for InvenioRDM*
 
+<a href="https://pypi.org/project/invenio-subjects-mesh-lite/">
+  <img src="https://img.shields.io/pypi/v/invenio-subjects-mesh-lite.svg">
+</a>
+
 Install this extension to get Medical Subject Headings topics without qualifiers into your instance.
 
 If you are looking for a larger MeSH vocabulary with qualifiers, use
@@ -24,21 +28,40 @@ This will add it to your Pipfile.
 
 ## Versions
 
-This repository follows [calendar versioning](https://calver.org/) for year and month:
+**From 2025.1.15.2 onwards**
 
-`2021.06.18` is both a valid semantic version and an indicator of the year-month corresponding to the loaded MeSH terms.
-`18` here is a patch number (not a day).
+This package follows the following format for versions: `YYYY.mm.dd.patch` where
+
+- `YYYY.mm.dd` is the date of retrieval of the MeSH terms with `mm` and `dd` NOT being 0-prefixed.
+- `patch` is the patch number (0-indexed) so that multiple releases can be done on the same day (bug/security fixes) and non-subject related releases can be done as well.
+
+This follows [calendar versioning](https://calver.org/) (for year, month, and day) and adds a patch number at the end. The package is typically updated on a quarterly basis. The following are illustrative (fictitious) examples of how to understand the versioning of this distribution package:
+
+| Last MeSH update included | patch number | version of this project |
+| ------------------------- | ------------ | ----------------------- |
+| 2025-06-31                | 2            | 2025.6.31.2             |
+| 2025-12-01                | 0            | 2025.12.1.0             |
+
+**Prior to 2025.1.15.2**
+
+This repository follows [calendar versioning](https://calver.org/) for year and month. It does a "best effort" attempt at tracking the MeSH updates in an *up-to-and-including* version date manner. The following are illustrative cases of how to understand the versioning of this distribution package:
+
+| Last MeSH update included | version of this project | date of release of this project |
+| ------------------------- | ----------------------- | ------------------------------- |
+| 2024-01-31                | 2024.1.X                | any time after 2024-01-31       |
+| 2023-12-31                | 2023.12.X               | any time after 2023-12-31       |
 
-So far the package is compatible with InvenioRDM 9.1+'s subjects "ABI". If there is a breaking change, a compatibility
-table will be provided to indicate version cross-compatibility.
+
+`2021.06.18` is both a valid semantic version and an indicator of the year-month corresponding to the loaded terms.
+`18` here is a patch number (not a day).
 
 ## Usage
 
-There are 2 types of users for this package. Instance administrators and package maintainers.
+There are 2 types of users for this package. Instance operators and package maintainers.
 
-### Instance administrators
+### Instance operators
 
-For instance administrators, after you have installed the extension as per the steps above, you will want to reload your instance's fixtures: `pipenv run invenio rdm-records fixtures`. This will install the new terms in your instance.
+For instance operators, after you have installed the extension as per the steps above, you will want to reload your instance's fixtures: `pipenv run invenio rdm-records fixtures`. This will install the new terms in your instance.
 
 Alternatively, or if you want to update your already loaded subjects to a new listing (e.g. from one year's list to another), you can update your instance's MeSH subjects as per below. Updating subjects this way takes care of everything for you: the subjects themselves and the records/drafts using those subjects. **WARNING** This operation can _remove_ subjects.
 
@@ -76,6 +99,8 @@ Once you have it installed, you can run the following commands in the isolated v
 (venv) invenio galter_subjects mesh file -d /path/to/downloads/storage/ -y YEAR -f topic -o invenio_subjects_mesh_lite/vocabularies/subjects_mesh.csv
 ```
 
+Sorting the resulting csv is a nice touch for humans to better parse the changes between versions.
+
 When you are happy with the list, bump the version in `pyproject.toml` and release it.
 
 
@@ -99,6 +124,17 @@ Run tests:
 pipenv run inv test
 ```
 
+Test compatibility with the pre-release version of InvenioRDM (invenio-app-rdm):
+
+```bash
+# Step 1 - install the pre-release dependencies
+(venv) pip install --pre -e .[dev_pre]
+# Step 2 - Run the pre-release tests
+(venv) inv test
+# if using uv run:
+uv run --extra dev_pre --prerelease=allow inv test
+```
+
 Check manifest:
 
 ```bash