Skip to main content

Subject terms tooling for InvenioRDM

Project description

galter-subjects-utils

Subjects tooling for InvenioRDM.

This distribution package provides an invenio subcommand group to manage controlled vocabulary subjects.

In particular, it provides functionality to

  • generate and update the initial list of subject terms for a vocabulary distribution package.
  • update a running instance's subjects by analyzing the delta between the instance and the updated target list of terms.

Although it contributes MeSH and LCSH terms functionality (those may be extracted out in the future), the goal is for this package to provide a framing for any subjects operations/CLI tooling. See https://github.com/galterlibrary/invenio-subjects-mesh for an example of how it fits in the ecosystem.

Installation

pip install galter-subjects-utils

Versions

This repository follows semantic versioning indexed on invenio-app-rdm compatibility according to the table below:

galter-subjects-utils invenio-app-rdm version
0.3.X 11.X
0.4.X 11.X

This just means for example that version 0.3 guarantees generation of subjects files and subject manipulation compatible with invenio-app-rdm v11. When there is a break in subjects format, this tool will bump its major version.

Usage

pipenv run invenio galter-subjects --help

Development

Install the project in editable mode with dev dependencies in an isolated virtualenv ((venv) denotes that going forward):

(venv) pip install -e .[dev]

Run tests:

(venv) invoke test
# or shorter
(venv) inv test

Check manifest:

(venv) inv check-manifest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

galter-subjects-utils-0.4.1.tar.gz (32.1 kB view hashes)

Uploaded Source

Built Distribution

galter_subjects_utils-0.4.1-py3-none-any.whl (31.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page