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.100.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 868345a8e10ef63cbbbb0f2ccf5c05fb1b1b6085739eed59c92e3cb6f2dfdae1 |
|
MD5 | 13d19b0c44d13b8c5795a67c4d05eb22 |
|
BLAKE2b-256 | b76b842f20e86cab13fe66adbf65331fbc3a2c6e8c227c18e1edc5723d847313 |
Hashes for oarepo_vocabularies-2.0.100-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e353bfce1204822eee08c67700905ed08b430652d2a1eda384eff3f1b9cb8323 |
|
MD5 | 828bf271299edd31154ca9fdcff1db65 |
|
BLAKE2b-256 | 6bd2082946c0bd3084309d7556202c2cbb35811d63455482cf4c2ba095730ee0 |