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)
Ordering
To support other than English ordering, sort
custom field has been added to the vocabulary api. This
custom field automatically populates sort.<lang>
mapping property for each language specified in the
configuration:
# invenio.cfg
from oarepo_runtime.cf.icu import ICUSortCF, ICUSuggestCF
OAREPO_VOCABULARIES_SORT_CF = [
ICUSortCF("cs", "czech", "title.cs", sort_option="title")
]
OAREPO_VOCABULARIES_SUGGEST_CF = [
ICUSuggestCF("cs", "czech", "title.cs")
]
When set up this way, the pre-fetched vocabularies (for ui inputs etc) are sorted as well.
Suggesting
To suggest in the actual locale, set the OAREPO_VOCABULARIES_SUGGEST_CF
as above.
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
Built Distribution
Hashes for oarepo-vocabularies-2.0.53.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 511b100f117735d014253e3bcddae8b57b5b05ac53c1c47388c627935be8e652 |
|
MD5 | 021af589c25e96c041af42610b7debf2 |
|
BLAKE2b-256 | a23c3787f5fbbe91c2e81404ed5ba16cb04bbbe7457d1400027b7ce1ff9de282 |
Hashes for oarepo_vocabularies-2.0.53-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2a1178cacb182ac782a65ef568a482305cdd6345bc6dc37c388dfa895bce431 |
|
MD5 | d56cac1dbd08793da22bd460f871cb31 |
|
BLAKE2b-256 | bc2f1dbaa6115095238dca7ff06cda9508d1053d76a605df930a01b53815563e |