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)
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
oarepo-vocabularies-2.0.40.tar.gz
(78.2 kB
view hashes)
Built Distribution
Close
Hashes for oarepo-vocabularies-2.0.40.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb1553afca5869123aadb38b1313caea19511649ceb1d57835f8b2c346479e46 |
|
MD5 | 1e9b0a4c42cdea09c515c57144b39c0b |
|
BLAKE2b-256 | aef95d2a8e7695d579d13724b412a4722042137fea18ef90c3c75f2685e1d60c |
Close
Hashes for oarepo_vocabularies-2.0.40-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ec345fb9acfbc6ba35ce88da3bd6cbe59ac4cacad716f20bd4903e2720b58a3 |
|
MD5 | 5def17cd9ef655da7bc98f99690e1bd5 |
|
BLAKE2b-256 | 450a735230c81474559bbb5deea6446a7b130b4dfc63c80d63bef7cde2a19c81 |