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.37.tar.gz
(78.4 kB
view hashes)
Built Distribution
Close
Hashes for oarepo-vocabularies-2.0.37.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26ade7ce12edb5e419afd45d85e8d18ee8c3928f14cc3582fe43afba7596169f |
|
MD5 | c6a4ed769b568c1edca381ed73fae3f5 |
|
BLAKE2b-256 | ecc707d5febade07713031659f3d6870bfedc33f1670eea609bf27074e3532af |
Close
Hashes for oarepo_vocabularies-2.0.37-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17b22637ee7cf229e0284e7c808bc08eb3c74c1999645be78f7a34c95e02558a |
|
MD5 | 3b3f4485036cb552f817bb7e48a1b46f |
|
BLAKE2b-256 | e10f60020f4d97c8205f155cbfcd5409e93cb32e411c99baf776fc682d566146 |