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.59.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 538790a42bc1d5befec896df9679cf5f9ce3ac297cb5dc034fa41cbb20d85e08 |
|
MD5 | 3e3215ca60c3ca970afa175701c505d3 |
|
BLAKE2b-256 | 396dbdd3c2c92224f4c134e4792a975a6fc256ac0aa8f05a7ae6c2590e1d5a37 |
Hashes for oarepo_vocabularies-2.0.59-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1148e337e49d10660260e69b3f38b529c3b80a63ef7f5b9f533b8730169923a |
|
MD5 | 4606170f7a7f37a8a30418b35f69e870 |
|
BLAKE2b-256 | e7ffda836bb3ca54d80ba607c41b500d829c0be8291c196c1a25366fe1be3a29 |