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.42.tar.gz
(78.2 kB
view hashes)
Built Distribution
Close
Hashes for oarepo-vocabularies-2.0.42.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f593f6ed606b9f7c022267fe97dad16f8198830d321b009f949199761b9e548e |
|
MD5 | e5eb3ba12c6afadcfa642ff59bc4df60 |
|
BLAKE2b-256 | 624d9a9226b18440a44e0b600945377bfba917cb1d0ec5e9148f86b88947269b |
Close
Hashes for oarepo_vocabularies-2.0.42-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8db8103ae730eac1bec48c37b617e3a71af33c98d8a233cdda9a66cc2f20c92a |
|
MD5 | efa80741e31d8a0a8e29269b9894c60a |
|
BLAKE2b-256 | 088e52b73a4cee1ce3d9a7cf0d0e50935696f8bb753e4dc8df2866a97e679a9e |