invenio-subjects-nasa


Nameinvenio-subjects-nasa JSON
Version 2.0.2 PyPI version JSON
download
home_pagehttps://github.com/Samk13/invenio-subjects-nasa
Summaryinvenio_subjects_nasa vocabularies
upload_time2024-02-07 16:44:30
maintainer
docs_urlNone
authorKTH Royal Institute of Technology
requires_python>=3.9
licenseMIT
keywords invenio vocabularies nasa
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # invenio-subjects-nasa

![Tests](https://github.com/Samk13/invenio-subjects-nasa/actions/workflows/tests.yml/badge.svg)

The NASA Thesaurus contains the authorized NASA subject terms used to index and retrieve materials in the STI Repository launch . The scope of this controlled vocabulary includes not only aerospace engineering, but all supporting areas of engineering and physics, the natural space sciences (astronomy, astrophysics, and planetary science), Earth sciences, and the biological sciences. The NASA Thesaurus contains over 18,400 subject terms, 4,300 definitions, and more than 4,500 USE cross references.

`invenio-subjects-nasa` for [InvenioRDM](https://inveniosoftware.org/products/rdm/) is an extension that provides the NASA thesaurus subject terms used to index and retrieve materials in the STI Repository into your instance.
Please read: [Invenio subjects documentation](https://inveniordm.docs.cern.ch/customize/vocabularies/subjects/)

## Installation

First, you need to install the package in your invenio instance.

```console
pip install invenio-subjects-nasa
```

Then, you need to add the subjects to your instance by running the following command:

```console
invenio rdm-records fixtures
invenio-cli run
```

This will add the NASA subjects to your instance, it can take a while to finish.
After that, you can check the subjects in your instance by going to the deposit page under `Keywords and subjects`.

### Versions

This repository follows [SemVer versioning](https://semver.org/):

## Usage

There are 2 types of users for this package. Maintainers of the package and instance administrators.

### Maintainers

### testing

```console
make install
make test
```

You can check if there are updates on the terms by checking the [NASA Thesaurus](https://sti.nasa.gov/nasa-thesaurus/).
If there are updates, you can download the csv file in the download folder and run the following command:

```console
make run
```

### Upload to pypi

Publishing will be done automatically by GitHub actions when a new tag is created.

```bash
git tag vX.Y.Z
git push origin master vX.Y.Z
```

### manually upload to pypi

```console
make install-package-tools # this will install twine (install-package-tools-pipenv if you use pipenv)
make package # this will zip the package into dist dir
make package-check # verify if the package pass twine checks

export TWINE_USERNAME=__token__
export TWINE_PASSWORD=pypi-<YOUR_TOKEN>
twine upload dist/*
```

# Changes

v2.0.2 (released 2024-02-07)

- Fix pypi deployment
- Update README.md

v2.0.0 (released 2024-02-07)

- Add GitHub actions for tests and pypi deployment
- Add Makefile and update setup.cfg and setup.py
- Update controlled vocabulary to 2024-02-07
- remove unused files and dependencies
- Add support for InvenioRDM v12.0.0
- Update license to the package
- Add tests for the package
- Update requirements
- sort terms by id

v1.1.2 (released 2022-08-18)

- Initial public release.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Samk13/invenio-subjects-nasa",
    "name": "invenio-subjects-nasa",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "invenio vocabularies nasa",
    "author": "KTH Royal Institute of Technology",
    "author_email": "info@kth.se",
    "download_url": "https://files.pythonhosted.org/packages/cd/44/a7439e355c52ef617afc4ac1e6ad7a9230aa87b8fe8531f2659fcb679ec7/invenio_subjects_nasa-2.0.2.tar.gz",
    "platform": "any",
    "description": "# invenio-subjects-nasa\n\n![Tests](https://github.com/Samk13/invenio-subjects-nasa/actions/workflows/tests.yml/badge.svg)\n\nThe NASA Thesaurus contains the authorized NASA subject terms used to index and retrieve materials in the STI Repository launch . The scope of this controlled vocabulary includes not only aerospace engineering, but all supporting areas of engineering and physics, the natural space sciences (astronomy, astrophysics, and planetary science), Earth sciences, and the biological sciences. The NASA Thesaurus contains over 18,400 subject terms, 4,300 definitions, and more than 4,500 USE cross references.\n\n`invenio-subjects-nasa` for [InvenioRDM](https://inveniosoftware.org/products/rdm/) is an extension that provides the NASA thesaurus subject terms used to index and retrieve materials in the STI Repository into your instance.\nPlease read: [Invenio subjects documentation](https://inveniordm.docs.cern.ch/customize/vocabularies/subjects/)\n\n## Installation\n\nFirst, you need to install the package in your invenio instance.\n\n```console\npip install invenio-subjects-nasa\n```\n\nThen, you need to add the subjects to your instance by running the following command:\n\n```console\ninvenio rdm-records fixtures\ninvenio-cli run\n```\n\nThis will add the NASA subjects to your instance, it can take a while to finish.\nAfter that, you can check the subjects in your instance by going to the deposit page under `Keywords and subjects`.\n\n### Versions\n\nThis repository follows [SemVer versioning](https://semver.org/):\n\n## Usage\n\nThere are 2 types of users for this package. Maintainers of the package and instance administrators.\n\n### Maintainers\n\n### testing\n\n```console\nmake install\nmake test\n```\n\nYou can check if there are updates on the terms by checking the [NASA Thesaurus](https://sti.nasa.gov/nasa-thesaurus/).\nIf there are updates, you can download the csv file in the download folder and run the following command:\n\n```console\nmake run\n```\n\n### Upload to pypi\n\nPublishing will be done automatically by GitHub actions when a new tag is created.\n\n```bash\ngit tag vX.Y.Z\ngit push origin master vX.Y.Z\n```\n\n### manually upload to pypi\n\n```console\nmake install-package-tools # this will install twine (install-package-tools-pipenv if you use pipenv)\nmake package # this will zip the package into dist dir\nmake package-check # verify if the package pass twine checks\n\nexport TWINE_USERNAME=__token__\nexport TWINE_PASSWORD=pypi-<YOUR_TOKEN>\ntwine upload dist/*\n```\n\n# Changes\n\nv2.0.2 (released 2024-02-07)\n\n- Fix pypi deployment\n- Update README.md\n\nv2.0.0 (released 2024-02-07)\n\n- Add GitHub actions for tests and pypi deployment\n- Add Makefile and update setup.cfg and setup.py\n- Update controlled vocabulary to 2024-02-07\n- remove unused files and dependencies\n- Add support for InvenioRDM v12.0.0\n- Update license to the package\n- Add tests for the package\n- Update requirements\n- sort terms by id\n\nv1.1.2 (released 2022-08-18)\n\n- Initial public release.\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "invenio_subjects_nasa vocabularies",
    "version": "2.0.2",
    "project_urls": {
        "Homepage": "https://github.com/Samk13/invenio-subjects-nasa"
    },
    "split_keywords": [
        "invenio",
        "vocabularies",
        "nasa"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cd44a7439e355c52ef617afc4ac1e6ad7a9230aa87b8fe8531f2659fcb679ec7",
                "md5": "592194c45b9b40421a1654e5aeff89d3",
                "sha256": "2b3c794b5c143f3b93820aff2e79ae1ead0181fe97a7f967e4ecd0c0b7b955d7"
            },
            "downloads": -1,
            "filename": "invenio_subjects_nasa-2.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "592194c45b9b40421a1654e5aeff89d3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 2286867,
            "upload_time": "2024-02-07T16:44:30",
            "upload_time_iso_8601": "2024-02-07T16:44:30.958623Z",
            "url": "https://files.pythonhosted.org/packages/cd/44/a7439e355c52ef617afc4ac1e6ad7a9230aa87b8fe8531f2659fcb679ec7/invenio_subjects_nasa-2.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-07 16:44:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Samk13",
    "github_project": "invenio-subjects-nasa",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "invenio-subjects-nasa"
}
        
Elapsed time: 0.19365s