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
This extension supports ordering and suggestion in different languages. It is enabled by default
and enables all languages in I18N_LANGUAGES
, BABEL_DEFAULT_LOCALE
. Sorting by title
sorts
by the title in the current language, suggestion suggests in id
and title in the default language.
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.93.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89e3b993e4c4941a71980643e9a95fcd8b6bdeca52e38a493864bd7173c56d9e |
|
MD5 | 33adb917b2c37e06d159ed5d51c18114 |
|
BLAKE2b-256 | 79a6b80154b73689ed537c68c435308be651406e08d45b1e5966c8da4f916085 |
Hashes for oarepo_vocabularies-2.0.93-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4958b019375d0188eedaf986720849149c7014ff6049cc4fbabf6d56f1a714bf |
|
MD5 | 2803463c2df682fffc62f789fce32988 |
|
BLAKE2b-256 | 9b322912e611fdf24fa317d91ac2b27f6721a5d67158a7bc4e448649228c4632 |