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.67.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd4624022be7ead9ed2f862a48359342a74d0f09fed6408aaa9ebc16915260f5 |
|
MD5 | effbb473c7d097ed9e60f8ebe5cbc7d8 |
|
BLAKE2b-256 | a874932fa898c94ad0d967b93a5f563aa75b3ee36b0d45b9d708918a4052d33d |
Hashes for oarepo_vocabularies-2.0.67-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d54429248676d252565733c7eebc4a8d5e3ac20aa684322f02bf6f4f7b011c9 |
|
MD5 | 28645ea6c953d11ea822a1c7c4c8b39a |
|
BLAKE2b-256 | 6c855b692c1dcadab25137a58c142439638fda3fdeb80b4e29e8535643a0fef3 |