| Name | invenio-subjects-lcsh JSON |
| Version |
2023.11.1
JSON |
| download |
| home_page | |
| Summary | LCSH subject terms for InvenioRDM |
| upload_time | 2023-11-09 19:49:35 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (C) 2021 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
lcsh
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# invenio-subjects-lcsh
*LCSH subject terms for InvenioRDM*
Install this extension to get [Library of Congress Subject Headings](https://id.loc.gov/authorities/subjects.html) into your instance.
## Installation
From your instance directory:
```bash
pipenv install invenio-subjects-lcsh
```
This will add it to your Pipfile.
## Versions
This repository follows [calendar versioning](https://calver.org/) for year and month:
`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).
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 which version is compatible with with InvenioRDM's "ABI".
## Usage
There are 2 types of users for this package. Maintainers of the package and instance administrators.
### Instance administrators
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.
Updating existing terms currently requires manual replacement.
### Maintainers
This package should probably be updated on a yearly basis. Here we show how.
0. Install this package locally with the `dev` extra:
```bash
pipenv run pip install -e .[dev]
```
1. Use the installed `galter-subjects-utils` tool to get the new list:
```bash
pipenv run galter-subjects-utils lcsh --output-file invenio_subjects_lcsh/vocabularies/subjects_lcsh.jsonl
```
This will
1. Download the new list(s)
2. Read it filtering for topics
3. Convert terms to InvenioRDM subjects format
4. Write those to the specified file
2. Check the manifest (it should typically be all good)
```bash
pipenv run inv check-manifest
```
3. When you are happy with the list, bump the version and release it.
## 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]
# or if using pipenv
pipenv run pip install -e .[dev]
```
Run tests:
```bash
(venv) invoke test
# or shorter
(venv) inv test
# or if using pipenv
pipenv run inv test
```
Check manifest:
```bash
(venv) inv check-manifest
# or if using pipenv
pipenv run inv check-manifest
```
Clean out artefacts:
```bash
(venv) inv clean
# or if using pipenv
pipenv run inv clean
```
Raw data
{
"_id": null,
"home_page": "",
"name": "invenio-subjects-lcsh",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "invenio,inveniordm,subjects,LCSH",
"author": "",
"author_email": "Northwestern University <DL_FSM_GDS@e.northwestern.edu>",
"download_url": "https://files.pythonhosted.org/packages/f5/62/7609656354060f948f88a51e188dfeb8f2659ae4c537b3e5d3bee1fe4dbb/invenio-subjects-lcsh-2023.11.1.tar.gz",
"platform": null,
"description": "# invenio-subjects-lcsh\n\n*LCSH subject terms for InvenioRDM*\n\nInstall this extension to get [Library of Congress Subject Headings](https://id.loc.gov/authorities/subjects.html) into your instance.\n\n## Installation\n\nFrom your instance directory:\n\n```bash\npipenv install invenio-subjects-lcsh\n```\n\nThis will add it to your Pipfile.\n\n## Versions\n\nThis repository follows [calendar versioning](https://calver.org/) for year and month:\n\n`2021.06.18` is both a valid semantic version and an indicator of the year-month corresponding to the loaded terms.\n`18` here is a patch number (not a day).\n\nSo far the package is compatible with InvenioRDM 9.1+'s subjects \"ABI\". If there is a breaking change, a compatibility\ntable will be provided to indicate which version is compatible with with InvenioRDM's \"ABI\".\n\n## Usage\n\nThere are 2 types of users for this package. Maintainers of the package and instance administrators.\n\n### Instance administrators\n\nFor 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.\n\nUpdating existing terms currently requires manual replacement.\n\n### Maintainers\n\nThis package should probably be updated on a yearly basis. Here we show how.\n\n0. Install this package locally with the `dev` extra:\n\n```bash\npipenv run pip install -e .[dev]\n```\n\n1. Use the installed `galter-subjects-utils` tool to get the new list:\n\n```bash\npipenv run galter-subjects-utils lcsh --output-file invenio_subjects_lcsh/vocabularies/subjects_lcsh.jsonl\n```\n\n This will\n\n 1. Download the new list(s)\n 2. Read it filtering for topics\n 3. Convert terms to InvenioRDM subjects format\n 4. Write those to the specified file\n\n2. Check the manifest (it should typically be all good)\n\n```bash\npipenv run inv check-manifest\n```\n\n3. When you are happy with the list, bump the version and release it.\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# or if using pipenv\npipenv run pip install -e .[dev]\n```\n\nRun tests:\n\n```bash\n(venv) invoke test\n# or shorter\n(venv) inv test\n# or if using pipenv\npipenv run inv test\n```\n\nCheck manifest:\n\n```bash\n(venv) inv check-manifest\n# or if using pipenv\npipenv run inv check-manifest\n```\n\nClean out artefacts:\n\n```bash\n(venv) inv clean\n# or if using pipenv\npipenv run inv clean\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (C) 2021 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": "LCSH subject terms for InvenioRDM",
"version": "2023.11.1",
"project_urls": {
"Repository": "https://github.com/galterlibrary/invenio-subjects-lcsh"
},
"split_keywords": [
"invenio",
"inveniordm",
"subjects",
"lcsh"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f26bd340d5e8fb4e0e801256cbd98e51340a97a8786862e019341447a42c8b83",
"md5": "71c95ddd11c1310166d4c9603d96ab6b",
"sha256": "5874e5f14ed2ea67ad2d6c3fc1421fd7d5a6ed45bc152445d58e5da604c8438a"
},
"downloads": -1,
"filename": "invenio_subjects_lcsh-2023.11.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "71c95ddd11c1310166d4c9603d96ab6b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6850930,
"upload_time": "2023-11-09T19:49:33",
"upload_time_iso_8601": "2023-11-09T19:49:33.304588Z",
"url": "https://files.pythonhosted.org/packages/f2/6b/d340d5e8fb4e0e801256cbd98e51340a97a8786862e019341447a42c8b83/invenio_subjects_lcsh-2023.11.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f5627609656354060f948f88a51e188dfeb8f2659ae4c537b3e5d3bee1fe4dbb",
"md5": "d3194b8da296e6a41753ac2b0e4ec13d",
"sha256": "49861fe5fb75a7bee26b70f90969bc998c1be9572ec7da54be0e512dd2feb3d3"
},
"downloads": -1,
"filename": "invenio-subjects-lcsh-2023.11.1.tar.gz",
"has_sig": false,
"md5_digest": "d3194b8da296e6a41753ac2b0e4ec13d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6559230,
"upload_time": "2023-11-09T19:49:35",
"upload_time_iso_8601": "2023-11-09T19:49:35.015163Z",
"url": "https://files.pythonhosted.org/packages/f5/62/7609656354060f948f88a51e188dfeb8f2659ae4c537b3e5d3bee1fe4dbb/invenio-subjects-lcsh-2023.11.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-09 19:49:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "galterlibrary",
"github_project": "invenio-subjects-lcsh",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "invenio-subjects-lcsh"
}
