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.34.tar.gz
(75.8 kB
view hashes)
Built Distribution
Close
Hashes for oarepo-vocabularies-2.0.34.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0e5d663c72b4eba9c232d1ab06e6622aa1bd2bc9c22283d2ea7081841ee737f |
|
MD5 | bf5559db92f594509f31e0d100591c6f |
|
BLAKE2b-256 | ec2d51541894d07d4be7b0bff65dbe8a3cd51e1ab704ae65c66df18124558c61 |
Close
Hashes for oarepo_vocabularies-2.0.34-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f07ec05e4db0b03bf568f77b63e77a70e92253d2999c1fa56c8a057c93e938e1 |
|
MD5 | 4f72789f26263fa2dd170ec131e1b7a3 |
|
BLAKE2b-256 | a6ab2a82d2b13e410105b9f0aa2a32fec3c3da2f8c261ed839c3a9c05dad0728 |