invenio-subjects-cessda


Nameinvenio-subjects-cessda JSON
Version 1.1.2 PyPI version JSON
download
home_pagehttps://github.com/Samk13/invenio-subjects-cessda
Summaryinvenio-subjects-cessda vocabularies
upload_time2024-02-08 14:43:28
maintainer
docs_urlNone
authorKTH Royal Institute of Technology
requires_python>=3.9
licenseMIT
keywords invenio inveniordm subjects cessda
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # invenio-subjects-cessda

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

## Overview

[CESSDA](https://www.cessda.eu/About) stands for Consortium of European Social Science Data Archives and ERIC stands for European Research Infrastructure Consortium.

CESSDA provides large-scale, integrated and sustainable data services to the social sciences. It brings together social science data archives across Europe, with the aim of promoting the results of social science research and supporting national and international research and cooperation.
`invenio-subjects-cessda` is a Python package designed to integrate the CESSDA Vocabulary with [InvenioRDM](https://inveniosoftware.org/products/rdm/)

## Installation

### Prerequisites

Active virtual environment of your InvenioRDM instance.
From your instance active venv:

### Steps

1- Install the package:

```bash
pip install invenio-subjects-cessda

```

2- Run the following commands in your InvenioRDM instance:

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

### Versioning

This project adheres to [SemVer versioning](https://semver.org/):

## Usage Guide

### For Instance Administrators

After installation:
1- Refer to [Invenio subjects documentation](https://inveniordm.docs.cern.ch/customize/vocabularies/subjects/)
2- Run the following commands:

```bash
pip install invenio-subjects-cessda
invenio rdm-records fixtures
invenio-cli run
```

Your instance is now ready to use the CESSDA vocabulary.

## For Package Maintainers

Setting Up Development Environment
After cloning the repository:

```bash
# Run make install to install dependencies.
make install
# Use make test to run tests.
make test
```

### Debugging

Modify `Makefile` to set the DEBUGGER environment variable to False for less detailed logging.

### Updating CESSDA Versions

Last updated: `2024-02-01`
Check the version date in this README. To fetch the latest CESSDA versions, run:

```bash
make run
```

in [config.py](invenio_subjects_cessda/config.py) you have the ability to modify the preferred language and specify the directory for saving vocabularies.
The endpoint `fullListOfpublishedVocabVersions` includes a full list of all published vocabulary versions enabling you to compare them with the versions that have been installed.

The following vocabulary versions are included in this release. Remember to update this list during your next upgrade.

```console
https://vocabularies.cessda.eu/v2/codes/CdcPublisherNames/6.0.0/en
https://vocabularies.cessda.eu/v2/codes/CessdaPersistentIdentifierTypes/1.0.0/en
https://vocabularies.cessda.eu/v2/codes/CountryNamesAndCodes/1.0.0/en
https://vocabularies.cessda.eu/v2/codes/TopicClassification/4.2.2/en
https://vocabularies.cessda.eu/v2/codes/AggregationMethod/1.1.2/en
https://vocabularies.cessda.eu/v2/codes/AnalysisUnit/2.1.3/en
https://vocabularies.cessda.eu/v2/codes/CharacterSet/1.0.0/en
https://vocabularies.cessda.eu/v2/codes/CommonalityType/1.0.2/en
https://vocabularies.cessda.eu/v2/codes/ContributorRole/1.0.2/en
https://vocabularies.cessda.eu/v2/codes/DataSourceType/1.0.2/en
https://vocabularies.cessda.eu/v2/codes/DataType/1.1.2/en
https://vocabularies.cessda.eu/v2/codes/DateType/1.1.2/en
https://vocabularies.cessda.eu/v2/codes/GeneralDataFormat/2.0.3/en
https://vocabularies.cessda.eu/v2/codes/LanguageProficiency/1.0.2/en
https://vocabularies.cessda.eu/v2/codes/LifecycleEventType/1.0.2/en
https://vocabularies.cessda.eu/v2/codes/ModeOfCollection/4.0.3/en
https://vocabularies.cessda.eu/v2/codes/NumericType/1.1.0/en
https://vocabularies.cessda.eu/v2/codes/ResponseUnit/1.0.2/en
https://vocabularies.cessda.eu/v2/codes/SamplingProcedure/1.1.4/en
https://vocabularies.cessda.eu/v2/codes/SoftwarePackage/1.0.0/en
https://vocabularies.cessda.eu/v2/codes/SummaryStatisticType/2.1.2/en
https://vocabularies.cessda.eu/v2/codes/TimeMethod/1.2.3/en
https://vocabularies.cessda.eu/v2/codes/TimeZone/1.0.0/en
https://vocabularies.cessda.eu/v2/codes/TypeOfAddress/1.1.0/en
https://vocabularies.cessda.eu/v2/codes/TypeOfConceptGroup/1.0.2/en
https://vocabularies.cessda.eu/v2/codes/TypeOfFrequency/1.0.0/en
https://vocabularies.cessda.eu/v2/codes/TypeOfInstrument/1.1.2/en
https://vocabularies.cessda.eu/v2/codes/TypeOfNote/1.1.0/en
https://vocabularies.cessda.eu/v2/codes/TypeOfTelephone/1.0.0/en
https://vocabularies.cessda.eu/v2/codes/TypeOfTranslationMethod/1.0.0/en
https://vocabularies.cessda.eu/v2/codes/Variables-Relations/1.0.0/en
```

## 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

```bash
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

Version 1.1.2

- Add github actions for publishing to pypi
- Add github actions for testing
- add test badge to readme
- Remove requirements.txt

Version 1.1.0

- update readme
- fix version number

Version 1.1.0

- Introduce Auto fetch new versions for all vocabularies
- Bump update dependencies to their latest versions
- Introduce debugging option to 'make run' command
- Refactor convert functionality and add sorting
- Update CESSDA vocabularies to 2024-02-01
- Add error handling to data fetching
- Bump requirements.txt

Version 1.0.0

- Initial public release 2022.11.03

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Samk13/invenio-subjects-cessda",
    "name": "invenio-subjects-cessda",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "invenio inveniordm subjects cessda",
    "author": "KTH Royal Institute of Technology",
    "author_email": "info@kth.se",
    "download_url": "https://files.pythonhosted.org/packages/72/5d/352ea8f90b98b533e422f107b46079ff76dccdd7c6cc783716c964336c38/invenio-subjects-cessda-1.1.2.tar.gz",
    "platform": "any",
    "description": "# invenio-subjects-cessda\n\n![Tests](https://github.com/Samk13/invenio-subjects-cessda/actions/workflows/tests.yaml/badge.svg)\n\n## Overview\n\n[CESSDA](https://www.cessda.eu/About) stands for Consortium of European Social Science Data Archives and ERIC stands for European Research Infrastructure Consortium.\n\nCESSDA provides large-scale, integrated and sustainable data services to the social sciences. It brings together social science data archives across Europe, with the aim of promoting the results of social science research and supporting national and international research and cooperation.\n`invenio-subjects-cessda` is a Python package designed to integrate the CESSDA Vocabulary with [InvenioRDM](https://inveniosoftware.org/products/rdm/)\n\n## Installation\n\n### Prerequisites\n\nActive virtual environment of your InvenioRDM instance.\nFrom your instance active venv:\n\n### Steps\n\n1- Install the package:\n\n```bash\npip install invenio-subjects-cessda\n\n```\n\n2- Run the following commands in your InvenioRDM instance:\n\n```console\ninvenio rdm-records fixtures\ninvenio-cli run\n```\n\n### Versioning\n\nThis project adheres to [SemVer versioning](https://semver.org/):\n\n## Usage Guide\n\n### For Instance Administrators\n\nAfter installation:\n1- Refer to [Invenio subjects documentation](https://inveniordm.docs.cern.ch/customize/vocabularies/subjects/)\n2- Run the following commands:\n\n```bash\npip install invenio-subjects-cessda\ninvenio rdm-records fixtures\ninvenio-cli run\n```\n\nYour instance is now ready to use the CESSDA vocabulary.\n\n## For Package Maintainers\n\nSetting Up Development Environment\nAfter cloning the repository:\n\n```bash\n# Run make install to install dependencies.\nmake install\n# Use make test to run tests.\nmake test\n```\n\n### Debugging\n\nModify `Makefile` to set the DEBUGGER environment variable to False for less detailed logging.\n\n### Updating CESSDA Versions\n\nLast updated: `2024-02-01`\nCheck the version date in this README. To fetch the latest CESSDA versions, run:\n\n```bash\nmake run\n```\n\nin [config.py](invenio_subjects_cessda/config.py) you have the ability to modify the preferred language and specify the directory for saving vocabularies.\nThe endpoint `fullListOfpublishedVocabVersions` includes a full list of all published vocabulary versions enabling you to compare them with the versions that have been installed.\n\nThe following vocabulary versions are included in this release. Remember to update this list during your next upgrade.\n\n```console\nhttps://vocabularies.cessda.eu/v2/codes/CdcPublisherNames/6.0.0/en\nhttps://vocabularies.cessda.eu/v2/codes/CessdaPersistentIdentifierTypes/1.0.0/en\nhttps://vocabularies.cessda.eu/v2/codes/CountryNamesAndCodes/1.0.0/en\nhttps://vocabularies.cessda.eu/v2/codes/TopicClassification/4.2.2/en\nhttps://vocabularies.cessda.eu/v2/codes/AggregationMethod/1.1.2/en\nhttps://vocabularies.cessda.eu/v2/codes/AnalysisUnit/2.1.3/en\nhttps://vocabularies.cessda.eu/v2/codes/CharacterSet/1.0.0/en\nhttps://vocabularies.cessda.eu/v2/codes/CommonalityType/1.0.2/en\nhttps://vocabularies.cessda.eu/v2/codes/ContributorRole/1.0.2/en\nhttps://vocabularies.cessda.eu/v2/codes/DataSourceType/1.0.2/en\nhttps://vocabularies.cessda.eu/v2/codes/DataType/1.1.2/en\nhttps://vocabularies.cessda.eu/v2/codes/DateType/1.1.2/en\nhttps://vocabularies.cessda.eu/v2/codes/GeneralDataFormat/2.0.3/en\nhttps://vocabularies.cessda.eu/v2/codes/LanguageProficiency/1.0.2/en\nhttps://vocabularies.cessda.eu/v2/codes/LifecycleEventType/1.0.2/en\nhttps://vocabularies.cessda.eu/v2/codes/ModeOfCollection/4.0.3/en\nhttps://vocabularies.cessda.eu/v2/codes/NumericType/1.1.0/en\nhttps://vocabularies.cessda.eu/v2/codes/ResponseUnit/1.0.2/en\nhttps://vocabularies.cessda.eu/v2/codes/SamplingProcedure/1.1.4/en\nhttps://vocabularies.cessda.eu/v2/codes/SoftwarePackage/1.0.0/en\nhttps://vocabularies.cessda.eu/v2/codes/SummaryStatisticType/2.1.2/en\nhttps://vocabularies.cessda.eu/v2/codes/TimeMethod/1.2.3/en\nhttps://vocabularies.cessda.eu/v2/codes/TimeZone/1.0.0/en\nhttps://vocabularies.cessda.eu/v2/codes/TypeOfAddress/1.1.0/en\nhttps://vocabularies.cessda.eu/v2/codes/TypeOfConceptGroup/1.0.2/en\nhttps://vocabularies.cessda.eu/v2/codes/TypeOfFrequency/1.0.0/en\nhttps://vocabularies.cessda.eu/v2/codes/TypeOfInstrument/1.1.2/en\nhttps://vocabularies.cessda.eu/v2/codes/TypeOfNote/1.1.0/en\nhttps://vocabularies.cessda.eu/v2/codes/TypeOfTelephone/1.0.0/en\nhttps://vocabularies.cessda.eu/v2/codes/TypeOfTranslationMethod/1.0.0/en\nhttps://vocabularies.cessda.eu/v2/codes/Variables-Relations/1.0.0/en\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```bash\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\nVersion 1.1.2\n\n- Add github actions for publishing to pypi\n- Add github actions for testing\n- add test badge to readme\n- Remove requirements.txt\n\nVersion 1.1.0\n\n- update readme\n- fix version number\n\nVersion 1.1.0\n\n- Introduce Auto fetch new versions for all vocabularies\n- Bump update dependencies to their latest versions\n- Introduce debugging option to 'make run' command\n- Refactor convert functionality and add sorting\n- Update CESSDA vocabularies to 2024-02-01\n- Add error handling to data fetching\n- Bump requirements.txt\n\nVersion 1.0.0\n\n- Initial public release 2022.11.03\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "invenio-subjects-cessda vocabularies",
    "version": "1.1.2",
    "project_urls": {
        "Homepage": "https://github.com/Samk13/invenio-subjects-cessda"
    },
    "split_keywords": [
        "invenio",
        "inveniordm",
        "subjects",
        "cessda"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "725d352ea8f90b98b533e422f107b46079ff76dccdd7c6cc783716c964336c38",
                "md5": "f685371d67dbf6ef5db2848c70c819e9",
                "sha256": "64ce48e662b2a00c448e4e8311e3ce59eab0ab2a10d2034ea99a97741861d50a"
            },
            "downloads": -1,
            "filename": "invenio-subjects-cessda-1.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "f685371d67dbf6ef5db2848c70c819e9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 58009,
            "upload_time": "2024-02-08T14:43:28",
            "upload_time_iso_8601": "2024-02-08T14:43:28.866030Z",
            "url": "https://files.pythonhosted.org/packages/72/5d/352ea8f90b98b533e422f107b46079ff76dccdd7c6cc783716c964336c38/invenio-subjects-cessda-1.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-08 14:43:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Samk13",
    "github_project": "invenio-subjects-cessda",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "invenio-subjects-cessda"
}
KTH Royal Institute of Technology
Elapsed time: 4.09213s