Kuha OAI-PMH Repo Handler Changelog¶

0.14.1 (2021-11-11)¶

Metadata rendered by prefix oai_ddi25 should place distrbtr-element before distDate-element in distStmt. (Fixes #21)

Ensure future compatibility with CESSDA Data Catalogue
- Require kuha_common 0.15.1
- Include elements /codeBook/docDscr/citation/titlStmt/titl and /codeBook/stdyDscr/citation/holdings/@URI to DDI 2.5 serializations.
- Use study.document_titles to populate /codeBook/docDscr/citation/titlStmt/titl and study.study_uris to populate /codeBook/stdyDscr/citation/holdings/@URI.
Drop testing with Python interpreters below py38.
- Add py39 to test environments.
- Remove py35, py36 and py37 from tox test environments.
- Remove tasks running tests with py35, py36 and py37 interpreters from Jenkinsfile.

Changes to EAD3 mapping:
- /ead/archdesc/dsc/c01/c02/did/daoset/dao/@daotype value is now “unknown” instead of “derived”
- study.principal_investigators are now divided into corpname & persname elements. If a principal investigator has an affiliated organization the value is placed into persname and the organization is placed into corpname. If a principal investigator has no affiliated organization, it’s value is expected to be an organization and the value is placed into corpname.
Lock pip version to 20.3.4 in install script, which is the latest pip that supports Python 3.5. The install script should be compatible with Ubuntu 16.04, which defaults to Python 3.5. The latest pip does not support Python 3.5 and therefore cannot be upgraded into.
Use ‘’python-latest’’ in Jenkinsfile. It is guaranteed to point to the latest python on the CI server. Note that this is a CI specific configuration and is not portable to some arbitrary Jenkins instance.
Add py39 to tox environments and use it in Jenkinsfile.
Upgrade to latest genshi 0.7.5 in requirements.txt. Python 3.9 introduced changes to ast module that were incompatible with previous genshi version 0.7.3 used.
Add six to requirements.txt, since genshi 0.7.5 requires it.

Fix unhandled AttributeError, when requesting a list response with an unsupported set-parameter. Respond with OAI error code “noRecordsMatch”. (Fixes #19)

Support Python 3.8: involves code changes to tests and requirement of kuha_common 0.14.0. No new functionality or bug fixes are introduced.

kuha_oai_pmh_repo_handler.oai.records.get_sets_list_from_query_result() Check for query_result item’s set.record_field_setspec using dict’s get-method, since the item may not have such key. Remove check for the record_field_setname, since it is acceptable to have an OAI set without a setName. (Fixes #18)

Use Study.related_publications to render relpubl elements in DDI 2.5. templates.
require kuha_common 0.13.0

Project source code management changed to git. Does not contain code changes to OAI-PMH Repo Handler.
INSTALL.rst now instructs to use Git instead of Mercurial.
requirements.txt: kuha_common 0.12.0

Add list_records.py to run through the entire ListRecords sequence on-demand.
setup.py: Create console script entry point to run list_records.py.
Add shell script to run the list_records entry point using runtime_env and Python virtualenv.

Fixes for EAD3 serialization:
- Correct schemaLocation declaration.
- Add missing daotype attribute which is required for dao-element.
- Don’t render empty langmaterial elements.

Support for EAD3 metadata with metadataPrefix ead3
Use study.data_kinds as an OAI-PMH set.
Render following DDI 2.5. elements in ddi_c and oai_ddi25 metadata:
- /codeBook/stdyDscr/citation/prodStmt/copyright
- /codeBook/stdyDscr/dataAccs/useStmt/citReq
- /codeBook/stdyDscr/dataAccs/useStmt/deposReq
- /codeBook/stdyDscr/stdyInfo/sumDscr/geogCover
- /codeBook/stdyDscr/stdyInfo/sumDscr/dataKind
Make sure ddi_c and oai_ddi25 templates won’t render duplicate ID-attributes per document.
Add metadataPrefix attribute to OAI-Header’s request element. (Fixes #15)
Add set, from and until attributes to OAI-Header’s request element.
Clear OAI-Header’s request elements attributes if response results in badVerb or badArgument.
Relax regex validating OAI-Identifier. (Fixes #16)
Add set info to resumptionToken and use it in subsequent queries to Document Store. (Fixes #17)
Fix unhandled exception when requesting a set with more than one colon.
Update python package requirements: * genshi 0.7.3 * kuha_common 0.10.0

DDI-C template: Handle the possibility of None values in variable.codelist_codes[n].code. (Fixes #14)
Support using base_url for OAI-PMH request element. (Implements #6)
- Add configuration option --oai-pmh-respond-with-requested-url which defaults to False. Using this computes the base url for OAI-PMH request element from the HTTP request.
Require kuha_common>=0.6.0.

Pin requirement to kuha_common version in requirements.txt. This way it is easier to use older releases.
Fix possible TypeError in kuha_oai_pmh_repo_handler.oai.records.is_valid_setspec(), by explicit check for None in kuha_oai_pmh_repo_handler.oai.records.get_set_specs_from_ds_record(). (Fixes #11)
Conceptual container elements should be presented even if no concept is found. (Implements #10)
Fix possible NameError in kuha_oai_pmh_repo_handler.oai.OAIRecord.add_question(). (Fixes #12)
Serve topcClas and keyword DDI 2.5 elements even if no @ID attribute can be found. (Implements #13)
Refactor end-to-end tests: Use kuha_common.testing package.

Add DDI 2.5 metadata format for CESSDA Data Catalogue. (Resolves #8)
scripts/install_kuha_oai_pmh_repo_handler_virtualenv.sh: Use pip to install & upgrade.

DDI-C metadata & template:
- Add support for Study.document_uris
- Add support for Study.publishers.attr_abbreviation
- Add missing vocabURI-attribute to topClas element
- Add missing vocabURI-attribute to keyword element
OAI-DC metadata & template:
- Use Study.document_uris for identifier.
Don’t require metadataPrefix when request contains resumptionToken. (Fixes #5)
Add upgrade flag to pip install command.

DDI-C metadata & template: add support for:
- Study.identifiers
- Study.distributors
- Study.time_methods
- Study.sampling_procedures
- Study.collection_modes
- Study.analysis_units
- Study.collection_periods
- Study.data_access_descriptions
Add support for Study.identifiers in OAI-DC metadata & template.
Fix incorrect handling of requested identifier when using OAI namespace-identifier. (Fixes #4)
Separate OAI-PMH error messages for no known item and invalid identifier structure