Support for custom fields and hierarchy on Invenio vocabularies
Project description
OARepo vocabularies
This is an extension of invenio vocabularies that allows:
- Use the vocabularies with custom fields
- Treat vocabulary items as hierarchy
Installation
Add oarepo-runtime
, oarepo-vocabularies
to your virtualenv an set up the following in your invenio.cfg
:
from oarepo_vocabularies.services.config import VocabulariesConfig
from oarepo_vocabularies.resources.config import VocabulariesResourceConfig
VOCABULARIES_SERVICE_CONFIG = VocabulariesConfig
VOCABULARIES_RESOURCE_CONFIG = VocabulariesResourceConfig
Documentation
See NRP documentation for more details.
Authorities
It is possible to provide authority sources for vocabularies. Configuration:
VOCABULARY_TYPE_METADATA = {
"funding": { # vocabulary of funding
"name": {
"en": "Funding"
},
"authority": FundingService
}
}
where:
from oarepo_vocabularies.authorities import AuthorityService
class FundingService(AuthorityService):
def search(self, query=None, page=1, size=10, **kwargs):
# performs an API and returns a listing
# of serialized vocabulary items, for example:
return {
'hits': {
'total': 2,
'hits': [
{"id": "03zsq2967", "title": {"en": "Funding 1"}},
{"id": "a4gfhtt56", "title": {"en": "Funding 2"}}
]
},
# optional pagination links here
}
def get(self, item_id, *, uow, value, **kwargs):
# performs lookup by id and returns vocabulary metadata
# in this example:
return next(x for x in self.search()['hits']['hits'] if x['id'] == item_id)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
oarepo-vocabularies-2.0.36.tar.gz
(77.2 kB
view hashes)
Built Distribution
Close
Hashes for oarepo-vocabularies-2.0.36.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b4d7c9fd1d9fb905a710a7d628ee75fe5dd3ee95e3dc65e3bea5ccd8d28ebadb |
|
MD5 | af8851435999538e08987e95f5c6f3b3 |
|
BLAKE2b-256 | 97dc86c316113cc2f620921d5444ac655e2a18736f4ebe5028cac1118473e950 |
Close
Hashes for oarepo_vocabularies-2.0.36-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 110ae8b0a5f5aeea531ee6ee010fd930719c82067b243e9b157f9bfb81bcf9a0 |
|
MD5 | 331d154d179406eb94de7b56fa0af80c |
|
BLAKE2b-256 | 873e6a9abd1288c17a02bfab0365196c323a221cb7710c92e0832f1059337362 |