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.88.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d98e320259fae09d3cbff71bd5e46ba6dd628efc9e81496f6b4c15c2211403d |
|
MD5 | 4f3c0dca2221f93c6179896a15bf2ca3 |
|
BLAKE2b-256 | b95783042a93d68462003d44fed94fb86e56aa9dc6b79459a5b7835c7ce55ae5 |
Hashes for oarepo_vocabularies-2.0.88-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1376b5639d7fe52a029a54148be4b0da641c4ce2d557aa3984e82f5569a5a564 |
|
MD5 | 72c1551c33d025cc1eea20b6706c8580 |
|
BLAKE2b-256 | b925a3273ecf7ab38f07dd8d47ed50d53685b1c860def6a0f31b0a25c513a162 |