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.38.tar.gz
(78.5 kB
view hashes)
Built Distribution
Close
Hashes for oarepo-vocabularies-2.0.38.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0e78afc3b61c8e38bdf650380040082e7bc4ab4d359343f855193c46e71e470 |
|
MD5 | b51b9059cfe83a339dbe4cb5961bdbaa |
|
BLAKE2b-256 | fe2a33dcf23fed1fbc2f400fb43df29fcf75b6bf3a8a8501f91d942bb217b57d |
Close
Hashes for oarepo_vocabularies-2.0.38-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f65c677889a28f71a1d0c0e0908af5c705571e37eeb76a5686a879f64442e715 |
|
MD5 | 28844a75f62c45f490a97bc8946046de |
|
BLAKE2b-256 | a0d434288d430e16e5a9bd1f5ba65814bbd49f19bf443e5246d4841be0dabdd0 |