| Name | galter-subjects-utils JSON |
| Version |
0.4.1
JSON |
| download |
| home_page | None |
| Summary | Subject terms tooling for InvenioRDM |
| upload_time | 2024-04-08 20:29:36 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (C) 2021-2023 Northwestern University. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
invenio
inveniordm
subjects
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
```bash
pip install galter-subjects-utils
```
### Versions
This repository follows [semantic versioning](https://semver.org/) 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
```bash
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):
```bash
(venv) pip install -e .[dev]
```
Run tests:
```bash
(venv) invoke test
# or shorter
(venv) inv test
```
Check manifest:
```bash
(venv) inv check-manifest
```
Raw data
{
"_id": null,
"home_page": null,
"name": "galter-subjects-utils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "invenio, inveniordm, subjects",
"author": null,
"author_email": "Northwestern University <DL_FSM_GDS@e.northwestern.edu>",
"download_url": "https://files.pythonhosted.org/packages/e2/01/3654e59a6a03438216f831c5d479c76c1d3ffb01b5aa78e7e18b67ab6d51/galter-subjects-utils-0.4.1.tar.gz",
"platform": null,
"description": "# galter-subjects-utils\n\n*Subjects tooling for InvenioRDM.*\n\nThis distribution package provides an invenio subcommand group to manage controlled vocabulary subjects.\n\nIn particular, it provides functionality to\n\n- generate and update the initial list of subject terms for a vocabulary distribution package.\n- update a running instance's subjects by analyzing the delta between the instance and the updated target list of terms.\n\nAlthough 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\nof how it fits in the ecosystem.\n\n## Installation\n\n```bash\npip install galter-subjects-utils\n```\n\n### Versions\n\nThis repository follows [semantic versioning](https://semver.org/) indexed on invenio-app-rdm compatibility according to the table below:\n\n| galter-subjects-utils | invenio-app-rdm version |\n| --------------------- | ----------------------- |\n| 0.3.X | 11.X |\n| 0.4.X | 11.X |\n\nThis 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.\n\n## Usage\n\n```bash\npipenv run invenio galter-subjects --help\n```\n\n## Development\n\nInstall the project in editable mode with `dev` dependencies in an isolated virtualenv (`(venv)` denotes that going forward):\n\n```bash\n(venv) pip install -e .[dev]\n```\n\nRun tests:\n\n```bash\n(venv) invoke test\n# or shorter\n(venv) inv test\n```\n\nCheck manifest:\n\n```bash\n(venv) inv check-manifest\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (C) 2021-2023 Northwestern University. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Subject terms tooling for InvenioRDM",
"version": "0.4.1",
"project_urls": {
"Repository": "https://github.com/galterlibrary/galter-subjects-utils"
},
"split_keywords": [
"invenio",
" inveniordm",
" subjects"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3be129b8832fb7256b040cca948e15fcef5aa48dbf8535c235e9c61dff17ea8e",
"md5": "2d2c56f2920f8da8389e01ee0e6edca3",
"sha256": "416d647d22dae333a30300de914277570bef9793f4af10d1a77fcd5222f4265e"
},
"downloads": -1,
"filename": "galter_subjects_utils-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2d2c56f2920f8da8389e01ee0e6edca3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 31429,
"upload_time": "2024-04-08T20:29:35",
"upload_time_iso_8601": "2024-04-08T20:29:35.549784Z",
"url": "https://files.pythonhosted.org/packages/3b/e1/29b8832fb7256b040cca948e15fcef5aa48dbf8535c235e9c61dff17ea8e/galter_subjects_utils-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e2013654e59a6a03438216f831c5d479c76c1d3ffb01b5aa78e7e18b67ab6d51",
"md5": "e5af0d5c961403b41b92d6e8f8d58617",
"sha256": "19b48a8507acc46e38edff84a039c7bf3b61b6c3cbb73ae178d21c581ea9b7f0"
},
"downloads": -1,
"filename": "galter-subjects-utils-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "e5af0d5c961403b41b92d6e8f8d58617",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 32123,
"upload_time": "2024-04-08T20:29:36",
"upload_time_iso_8601": "2024-04-08T20:29:36.707415Z",
"url": "https://files.pythonhosted.org/packages/e2/01/3654e59a6a03438216f831c5d479c76c1d3ffb01b5aa78e7e18b67ab6d51/galter-subjects-utils-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-08 20:29:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "galterlibrary",
"github_project": "galter-subjects-utils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "galter-subjects-utils"
}
