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.102.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1db6ba84aba8c97867909ec0b8b758ca7157b6f58970513549c65db9bd5807d |
|
MD5 | be647272347081021c11bc44d7e32c41 |
|
BLAKE2b-256 | 8a5eef477ecd78d093b6562b914a14f90be525f27a6d9aabaefc183fce6ee478 |
Hashes for oarepo_vocabularies-2.0.102-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f91bcf4d349c4006c4bd93ee059710082692d70504e8c558bf1a30a263994cc |
|
MD5 | 7b04ec2647da29ee530d9cd9a291604a |
|
BLAKE2b-256 | 8cffb86522afe75d510d97ddec00f48400ed85d5f548a3e434ef561fb37c27e7 |