diff --git a/.docker-base/Dockerfile b/.docker-base/Dockerfile
index 2152183a410302df34d35ec6f514399678e0baaf..923924e75e03c6ca8346b17cdf87eda78efd766f 100644
--- a/.docker-base/Dockerfile
+++ b/.docker-base/Dockerfile
@@ -9,6 +9,34 @@ RUN apk add --no-cache py3-pip python3 python3-dev gcc make \
git bash curl gettext py3-requests
RUN apk add --no-cache libffi-dev openssl-dev libc-dev libxslt libxslt-dev \
libxml2 libxml2-dev
+
+# install rust (needed for compiling a docker-compose dependency)
+# This is necessary until alpine comes with an up to date RUST
+# copied from https://github.com/rust-lang/docker-rust/blob/bbc7feb12033da3909dced4e88ddbb6964fbc328/1.50.0/alpine3.13/Dockerfile
+
+ENV RUSTUP_HOME=/usr/local/rustup \
+ CARGO_HOME=/usr/local/cargo \
+ PATH=/usr/local/cargo/bin:$PATH \
+ RUST_VERSION=1.50.0
+
+RUN set -eux; \
+ apkArch="$(apk --print-arch)"; \
+ case "$apkArch" in \
+ x86_64) rustArch='x86_64-unknown-linux-musl'; rustupSha256='05c5c05ec76671d73645aac3afbccf2187352fce7e46fc85be859f52a42797f6' ;; \
+ aarch64) rustArch='aarch64-unknown-linux-musl'; rustupSha256='6a8a480d8d9e7f8c6979d7f8b12bc59da13db67970f7b13161ff409f0a771213' ;; \
+ *) echo >&2 "unsupported architecture: $apkArch"; exit 1 ;; \
+ esac; \
+ url="https://static.rust-lang.org/rustup/archive/1.23.1/${rustArch}/rustup-init"; \
+ wget "$url"; \
+ echo "${rustupSha256} *rustup-init" | sha256sum -c -; \
+ chmod +x rustup-init; \
+ ./rustup-init -y --no-modify-path --profile minimal --default-toolchain $RUST_VERSION --default-host ${rustArch}; \
+ rm rustup-init; \
+ chmod -R a+w $RUSTUP_HOME $CARGO_HOME; \
+ rustup --version; \
+ cargo --version; \
+ rustc --version;
+
RUN pip3 install docker-compose==1.25
# Script for waiting on LA server
diff --git a/.docker/Dockerfile b/.docker/Dockerfile
index d5d2fe66770b2d37f7ecbb718a2260cdd7f501c1..1651fa08f7fb157e007cf5c4a992f548b7d411ba 100644
--- a/.docker/Dockerfile
+++ b/.docker/Dockerfile
@@ -15,16 +15,18 @@ RUN apt-get update && \
python3-pytest \
libxml2 \
-y
+
+
COPY .docker/wait-for-it.sh /wait-for-it.sh
ADD https://gitlab.com/api/v4/projects/13656973/repository/branches/dev \
pylib_version.json
RUN git clone https://gitlab.com/caosdb/caosdb-pylib.git && \
cd caosdb-pylib && git checkout dev && pip3 install .
+# At least recommonmark 0.6 required.
+RUN pip3 install recommonmark sphinx-rtd-theme
COPY . /git
RUN rm -r /git/.git \
&& mv /git/.docker/pycaosdb.ini /git/integrationtests
RUN cd /git && pip3 install .
WORKDIR /git/integrationtests
CMD /wait-for-it.sh caosdb-server:10443 -t 500 -- ./test.sh
-# At least recommonmark 0.6 required.
-RUN pip3 install recommonmark sphinx-rtd-theme
diff --git a/.docker/docker-compose.yml b/.docker/docker-compose.yml
index e859e4337653a41dd2e17a819760b18fe2185c5e..36964ee68b7e384267a08484524de1f72cdfad6d 100644
--- a/.docker/docker-compose.yml
+++ b/.docker/docker-compose.yml
@@ -7,7 +7,7 @@ services:
networks:
- caosnet
caosdb-server:
- image: "$CI_REGISTRY_INDISCALE/caosdb/src/caosdb-deploy:$CAOSDB_TAG"
+ image: "$CI_REGISTRY/caosdb/src/caosdb-deploy:$CAOSDB_TAG"
user: 999:999
depends_on:
- sqldb
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 8ad682bf6bac6b50ed6a98ffe42b94f2c96aabb0..2a80211839ae3db85765c99629247f06e2c6778b 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -21,13 +21,9 @@
# along with this program. If not, see <https://www.gnu.org/licenses/>.
variables:
- CI_REGISTRY_IMAGE: $CI_REGISTRY/caosdb/caosdb-advanced-user-tools/testenv:latest
- CI_REGISTRY_IMAGE_BASE: $CI_REGISTRY/caosdb/caosdb-advanced-user-tools/base:latest
- # When using dind, it's wise to use the overlayfs driver for
- # improved performance.
+ CI_REGISTRY_IMAGE: $CI_REGISTRY/caosdb/src/caosdb-advanced-user-tools/testenv:latest
+ CI_REGISTRY_IMAGE_BASE: $CI_REGISTRY/caosdb/src/caosdb-advanced-user-tools/base:latest
-services:
- - docker:19.03.0-dind
stages:
- setup
@@ -38,7 +34,14 @@ stages:
- deploy
test:
- tags: [cached-dind]
+ tags: [docker]
+ services:
+ - docker:20.10.5-dind
+ variables:
+ # This is a workaround for the gitlab-runner health check mechanism when
+ # using docker-dind service. The runner will otherwise guess the port
+ # wrong and the health check will timeout.
+ SERVICE_PORT_2376_TCP_PORT: 2375
stage: integrationtest
image: $CI_REGISTRY_IMAGE_BASE
script:
@@ -48,12 +51,8 @@ test:
- echo $CAOSDB_TAG
- time docker load < /image-cache/caosdb-advanced-testenv.tar || true
- time docker load < /image-cache/mariadb.tar || true
- - time docker load < /image-cache/caosdb.tar || true
+ - time docker load < /image-cache/caosdb-dev.tar || true
- docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
- - docker login -u gitlab+deploy-token-ci-pull -p $TOKEN_CI_PULL $CI_REGISTRY_INDISCALE
- - time docker pull $CI_REGISTRY_IMAGE
- - time docker pull mariadb:10.4
- - time docker pull $CI_REGISTRY_INDISCALE/caosdb/src/caosdb-deploy:$CAOSDB_TAG
- EXEPATH=`pwd` CAOSDB_TAG=$CAOSDB_TAG docker-compose
-f .docker/docker-compose.yml up -d
- cd .docker
@@ -76,11 +75,10 @@ build-testenv:
tags: [cached-dind]
image: docker:18.09
stage: setup
- only:
- - schedules
- - web
+ # Hint: do not use only here; the image needs always to be build since it
+ # contains the repo code
+ #only:
script:
- - df -h
- docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
# use here general latest or specific branch latest...
- docker build
@@ -109,7 +107,7 @@ style:
stage: style
image: $CI_REGISTRY_IMAGE
script:
- - autopep8 -ar --diff --exit-code .
+ - autopep8 -ar --diff --exit-code --exclude swagger_client .
allow_failure: true
unittest:
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 3973a4b3f6b0098b871abf6394e5b9158b3e43c2..dfba5bc03ecb58fd56711b609536e66481114cec 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -26,9 +26,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
get_file_via_download
- Automated documentation builds: `make doc`
- Crawler documentation
+- Proof-of-concept integration with Bloxberg.
### Changed ###
+- identifiables must have at least one property or a name
* `caosadvancedtools.serverside.helper.init_data_model` also checks the role
and data type of entities.
* The `caosadvancedtools.table_importer.date_converter` now actually returns
diff --git a/README.md b/README.md
index 5208a711f72a3daa919e9195a5a0b05413e3de3a..2a29b8cfec187c483eb6d420dcaa5d8c7a1b3ad4 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,49 @@
-[](https://gitlab.com/caosdb/caosdb-advanced-user-tools/commits/master)
+# README
-Project migrated to https://gitlab.com/caosdb
-
-# Welcome
+## Welcome
This is the **CaosDB Advanced User Tools** repository and a part of the
-CaosDB project. This project contains tools that are beyond the typical use of
+CaosDB project.
+This project contains tools that are beyond the typical use of
the CaosDB python client. Especially, this includes the crawler which will
typically be used by a data curator.
-# Setup
+## Setup
Please read the [README_SETUP.md](README_SETUP.md) for instructions on how to
setup this code.
-# Further Reading
+## Further Reading
+
+Please refer to the [official documentation](https://docs.indiscale.com/caosdb-advanced-user-tools/) for more information.
+
+## Contributing
+
+Thank you very much to all contributers—[past, present](https://gitlab.com/caosdb/caosdb/-/blob/dev/HUMANS.md), and prospective ones.
-Please refer to the [official gitlab repository of the CaosDB
-project](https://gitlab.com/caosdb/caosdb) for more information.
+### Code of Conduct
-# License
+By participating, you are expected to uphold our [Code of Conduct](https://gitlab.com/caosdb/caosdb/-/blob/dev/CODE_OF_CONDUCT.md).
-Copyright (C) 2018 Research Group Biomedical Physics, Max Planck Institute for
-Dynamics and Self-Organization Göttingen.
+### How to Contribute
+
+* You found a bug, have a question, or want to request a feature? Please
+[create an issue](https://gitlab.com/caosdb/caosdb-advanced-user-tools/-/issues).
+* You want to contribute code? Please fork the repository and create a merge
+request in GitLab and choose this repository as target. Make sure to select
+"Allow commits from members who can merge the target branch" under Contribution
+when creating the merge request. This allows our team to work with you on your request.
+- If you have a suggestion for the [documentation](https://docs.indiscale.com/caosdb-advanced-user-tools/),
+the preferred way is also a merge request as describe above (the documentation resides in `src/doc`).
+However, you can also create an issue for it.
+- You can also contact us at **info (AT) caosdb.de**.
+
+## License
+
+* Copyright (C) 2018 Research Group Biomedical Physics, Max Planck Institute
+ for Dynamics and Self-Organization Göttingen.
+* Copyright (C) 2020-2021 Indiscale GmbH <info@indiscale.com>
All files in this repository are licensed under a [GNU Affero General Public
License](LICENCE.md) (version 3 or later).
-
diff --git a/README_SETUP.md b/README_SETUP.md
index 243fba2dd1259aaefbe6c7163a242b700eb5a66e..9b7b27ec056583708a8773ebac49f37ff45d9fd4 100644
--- a/README_SETUP.md
+++ b/README_SETUP.md
@@ -14,7 +14,7 @@ Dependencies will be installed automatically if you use the below described proc
- `xlrd>=1.2.0`
For testing:
-- `tox`
+- `tox`
## Installation
@@ -33,7 +33,7 @@ For testing:
the extroot of the empty profile to be used is located at).
3. Start an empty (!) CaosDB instance (with the mounted extroot). The
database will be cleared during testing, so it's important to use
- an empty insctance.
+ an empty instance.
4. Run `test.sh`.
## Code Formatting
diff --git a/integrationtests/test_crawler_basics.py b/integrationtests/test_crawler_basics.py
index 85fca282c8546ad1e7f6a708a2eaf46e374a528f..7da90844f14cf0d1eaded9d4fc8f37320da46aad 100644
--- a/integrationtests/test_crawler_basics.py
+++ b/integrationtests/test_crawler_basics.py
@@ -65,6 +65,7 @@ class CrawlerTest(unittest.TestCase):
self.rec2.add_parent(name="Test_Type_2")
self.rec3 = db.Record()
self.rec3.add_parent(name="Test_Type_3")
+ self.rec3.add_property(name="Test_Prop", value="Test")
def test_check_existence(self):
# This hasn't been inserted yet:
@@ -92,6 +93,7 @@ class CrawlerTest(unittest.TestCase):
old_id = id(identifiables[0])
reference_to_first = identifiables[0]
assert reference_to_first is identifiables[0]
+
Crawler.find_or_insert_identifiables(identifiables)
for el in identifiables:
@@ -107,6 +109,7 @@ class CrawlerTest(unittest.TestCase):
def tearDown(self):
setup_module()
+
# Delete nameless entities
for el in [self.rec1, self.rec2, self.rec3]:
try:
diff --git a/integrationtests/test_im_und_export.py b/integrationtests/test_im_und_export.py
index 5c7584e6f98ee792789f144d89f13ef84a7467fc..db26249b14d3d547db8dcea4e49de2aa07479e5b 100644
--- a/integrationtests/test_im_und_export.py
+++ b/integrationtests/test_im_und_export.py
@@ -13,13 +13,8 @@ if __name__ == "__main__":
directory = TemporaryDirectory()
export(rec.id, directory=directory.name)
# delete everything
- rec = db.execute_query("FIND record which was inserted by me")
- prop = db.execute_query("FIND property which was inserted by me")
- rt = db.execute_query("FIND recordtype which was inserted by me")
- fi = db.execute_query("FIND file which was inserted by me")
- c = db.Container()
- c.extend(rec+prop+rt+fi)
- c.delete()
+ recs = db.execute_query("FIND entity with id>99")
+ recs.delete()
assert 0 == len(db.execute_query("FIND File which is stored at "
"**/poster.pdf"))
import_xml(os.path.join(directory.name, "caosdb_data.xml"), interactive=False)
diff --git a/src/caosadvancedtools/bloxberg/__init__.py b/src/caosadvancedtools/bloxberg/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..5ca50276b8fd48370fd84bd0f5358dd1e48d6b8e
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/__init__.py
@@ -0,0 +1,4 @@
+"""Integration with the Bloxberg proof-of-existence blockchain.
+"""
+
+print("Warning: The Bloxberg module is still experimental and under active development.")
diff --git a/src/caosadvancedtools/bloxberg/bloxberg.py b/src/caosadvancedtools/bloxberg/bloxberg.py
new file mode 100644
index 0000000000000000000000000000000000000000..42af1e11a23a37214ec294b8032517bb5c70bb5b
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/bloxberg.py
@@ -0,0 +1,197 @@
+# This file is a part of the CaosDB Project.
+#
+# Copyright (C) 2021 IndiScale GmbH <info@indiscale.com>
+# Copyright (C) 2021 Daniel Hornung <d.hornung@indiscale.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+"""Interaction with the Bloxberg blockchain.
+"""
+
+
+import hashlib
+import json
+import secrets
+
+import caosdb as db
+
+from ..models.parser import parse_model_from_string
+from . import swagger_client
+
+
+__model_yaml = """
+BloxbergCertificate:
+ obligatory_properties:
+ pepper:
+ datatype: TEXT
+ hash:
+ datatype: TEXT
+ proofValue:
+ datatype: TEXT
+ certificateJSON:
+ datatype: TEXT
+ recommended_properties:
+ certified:
+ datatype: REFERENCE
+"""
+__model = parse_model_from_string(__model_yaml)
+
+
+class Bloxberg:
+ """A Bloxberg instance can be used to obtain or verify certificates."""
+
+ def __init__(self, connection=None):
+ """A Bloxberg instance can be used to obtain or verify certificates.
+
+Parameters
+----------
+connection : dict
+A dict with the following keys:
+ - url : The bloxberg URL. Default is "https://qa.certify.bloxberg.org"
+ """
+ self._create_conf(connection)
+ self._api_client = swagger_client.ApiClient(configuration=self._conf)
+ self._api = swagger_client.CertificateApi(self._api_client)
+
+ def _create_conf(self, connection=None):
+ """Generate a Swagger configuration object."""
+ self._conf = swagger_client.Configuration()
+ if connection:
+ if "URL" in connection:
+ self._conf.host = connection["URL"]
+
+ def certify(self, entity):
+ """Attempt to certify the given `entity` and return a certificate Record.
+
+Parameters
+----------
+entity : caosdb.Entity
+The entity to be certified
+
+Returns
+-------
+out : caosdb.Record
+A BloxbergCertificate Record with all the necessary Properties.
+"""
+ # Calculate hash
+ pepper = str(secrets.randbits(1024))
+ entity.retrieve()
+ hasher = hashlib.sha256()
+ hasher.update(pepper.encode(encoding="utf8"))
+ hasher.update(str(entity).encode(encoding="utf8"))
+ entity_hash = "0x" + hasher.hexdigest()
+ print(entity_hash)
+ pubkey = "0x9858eC18a269EE69ebfD7C38eb297996827DDa98" # TODO The key of the API server?
+ # Create body
+ body = swagger_client.Batch(public_key=pubkey, crid=[entity_hash], crid_type="sha2-256",
+ enable_ipfs=False)
+ # Submit hash & obtain response
+ result = self._api.create_bloxberg_certificate_create_bloxberg_certificate_post(body=body)
+ attribute_map = result[0].attribute_map
+ cert = result[0].to_dict()
+ for old, new in attribute_map.items():
+ if old == new:
+ continue
+ cert[new] = cert.pop(old)
+ json_s = json.dumps(cert)
+ # Generate result Record
+ cert_rec = db.Record().add_parent("BloxbergCertificate")
+ # Extract information and put into result
+ cert_rec.add_property(property="certified", value=entity)
+ cert_rec.add_property(property="pepper", value=pepper)
+ cert_rec.add_property(property="hash", value=entity_hash)
+ cert_rec.add_property(property="proofvalue", value=cert["proof"]["proofValue"])
+ cert_rec.add_property(property="certificateJSON", value=json_s)
+ # Return result
+ return cert_rec
+
+ def verify(self, certificate):
+ """Attempt to verify the certificate.
+
+A certificate passes verification if the Bloxberg instance says it is good. Typical use cases may
+also include the `validate` step to make sure that the certificate's original data exists and
+contains what it claimed to contain when the certificate was created.
+
+This method does nothing if the verification passes, else it raises an exception.
+
+Parameters
+----------
+certificate : caosdb.Record
+The BloxbergCertificate Record which shall be verified.
+
+ """
+ raise NotImplementedError("Bloxberg first needs to implement a verification API method.")
+
+ @staticmethod
+ def json_from_certificate(certificate, filename=None):
+ """Generate a qa.certify.bloxberg.org JSON string, optionally writing it to a file.
+
+Parameters
+----------
+certificate : caosdb.Record
+The BloxbergCertificate Record for which the JSON is generated.
+
+filename : str
+Write the JSON to this file.
+"""
+ content = {}
+
+ return content
+
+
+def ensure_data_model(force=False):
+ """Make sure that the data model fits our needs.
+
+ Most importantly, this means that a suitable RecordType "BoxbergCertificate" must exist.
+ """
+ __model.sync_data_model(noquestion=force)
+
+
+def certify_entity(entity, json_filename=None):
+ """Certify the given entity and store the result in the CaosDB.
+
+Parameters
+----------
+entity : caosdb.Entity
+ The Entity to be certified.
+
+json_filename : str
+ If given, store the JSON here.
+"""
+ if isinstance(entity, int):
+ entity = db.Entity(id=entity)
+
+ blx = Bloxberg()
+ print("Obtaining certificate...")
+ certificate = blx.certify(entity)
+ print("Certificate was successfully obtained.")
+ certificate.insert()
+ print("Certificate was stored in CaosDB.")
+
+ if json_filename:
+ with open(json_filename, "w") as json_file:
+ json_file.write(certificate.get_property("certificateJSON").value)
+
+
+def demo_run():
+ """Run the core functions for demonstration purposes."""
+ print("Making sure that the remote data model is up to date.")
+ ensure_data_model()
+ print("Data model is up to date.")
+ import caosdb as db
+ CertRT = db.RecordType(name="BloxbergCertificate").retrieve()
+ print("Certifying the `BloxbergCertificate` RecordType...")
+ json_filename = "/tmp/cert.json"
+ certify_entity(CertRT, json_filename=json_filename)
+ print("Certificate json file can be found here: {}".format(json_filename))
+ print("You can verify the certificate here: https://certify.bloxberg.org/verify")
diff --git a/src/caosadvancedtools/bloxberg/swagger_client/__init__.py b/src/caosadvancedtools/bloxberg/swagger_client/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..136c5b27a37cfbd9135230468ae5a29cb0eb2b77
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/swagger_client/__init__.py
@@ -0,0 +1,34 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+ Research Object Certification
+
+ No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
+
+ OpenAPI spec version: 0.2.0
+
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+# Fake the installation
+import sys, pathlib
+__this_dir = str(pathlib.Path(__file__).parent.parent)
+if __this_dir not in sys.path:
+ sys.path.append(__this_dir)
+
+# import apis into sdk package
+from swagger_client.api.certificate_api import CertificateApi
+from swagger_client.api.pdf_api import PdfApi
+# import ApiClient
+from swagger_client.api_client import ApiClient
+from swagger_client.configuration import Configuration
+# import models into sdk package
+from swagger_client.models.batch import Batch
+from swagger_client.models.controller_cert_tools_generate_pdf_json_certificate import ControllerCertToolsGeneratePdfJsonCertificate
+from swagger_client.models.controller_cert_tools_generate_unsigned_certificate_json_certificate import ControllerCertToolsGenerateUnsignedCertificateJsonCertificate
+from swagger_client.models.http_validation_error import HTTPValidationError
+from swagger_client.models.validation_error import ValidationError
diff --git a/src/caosadvancedtools/bloxberg/swagger_client/api/__init__.py b/src/caosadvancedtools/bloxberg/swagger_client/api/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..d33c26ea8bc245108934d5e0e9fdcd046da3232e
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/swagger_client/api/__init__.py
@@ -0,0 +1,7 @@
+from __future__ import absolute_import
+
+# flake8: noqa
+
+# import apis into api package
+from swagger_client.api.certificate_api import CertificateApi
+from swagger_client.api.pdf_api import PdfApi
diff --git a/src/caosadvancedtools/bloxberg/swagger_client/api/certificate_api.py b/src/caosadvancedtools/bloxberg/swagger_client/api/certificate_api.py
new file mode 100644
index 0000000000000000000000000000000000000000..0f0f1c6a5a51ff4d2338df4c6e233b93fc2a950a
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/swagger_client/api/certificate_api.py
@@ -0,0 +1,132 @@
+# coding: utf-8
+
+"""
+ Research Object Certification
+
+ No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
+
+ OpenAPI spec version: 0.2.0
+
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+import re # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from swagger_client.api_client import ApiClient
+
+
+class CertificateApi(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ Ref: https://github.com/swagger-api/swagger-codegen
+ """
+
+ def __init__(self, api_client=None):
+ if api_client is None:
+ api_client = ApiClient()
+ self.api_client = api_client
+
+ def create_bloxberg_certificate_create_bloxberg_certificate_post(self, body, **kwargs): # noqa: E501
+ """Createbloxbergcertificate # noqa: E501
+
+ Creates, transacts, and signs a research object certificate on the bloxberg blockchain. Hashes must be generated client side for each desired file and provided in an array. Each hash corresponds to one research object certificate returned in a JSON object array. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.create_bloxberg_certificate_create_bloxberg_certificate_post(body, async_req=True)
+ >>> result = thread.get()
+
+ :param async_req bool
+ :param Batch body: (required)
+ :return: list[ControllerCertToolsGenerateUnsignedCertificateJsonCertificate]
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('async_req'):
+ return self.create_bloxberg_certificate_create_bloxberg_certificate_post_with_http_info(body, **kwargs) # noqa: E501
+ else:
+ (data) = self.create_bloxberg_certificate_create_bloxberg_certificate_post_with_http_info(body, **kwargs) # noqa: E501
+ return data
+
+ def create_bloxberg_certificate_create_bloxberg_certificate_post_with_http_info(self, body, **kwargs): # noqa: E501
+ """Createbloxbergcertificate # noqa: E501
+
+ Creates, transacts, and signs a research object certificate on the bloxberg blockchain. Hashes must be generated client side for each desired file and provided in an array. Each hash corresponds to one research object certificate returned in a JSON object array. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.create_bloxberg_certificate_create_bloxberg_certificate_post_with_http_info(body, async_req=True)
+ >>> result = thread.get()
+
+ :param async_req bool
+ :param Batch body: (required)
+ :return: list[ControllerCertToolsGenerateUnsignedCertificateJsonCertificate]
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['body'] # noqa: E501
+ all_params.append('async_req')
+ all_params.append('_return_http_data_only')
+ all_params.append('_preload_content')
+ all_params.append('_request_timeout')
+
+ params = locals()
+ for key, val in six.iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method create_bloxberg_certificate_create_bloxberg_certificate_post" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the required parameter 'body' is set
+ if ('body' not in params or
+ params['body'] is None):
+ raise ValueError("Missing the required parameter `body` when calling `create_bloxberg_certificate_create_bloxberg_certificate_post`") # noqa: E501
+
+ collection_formats = {}
+
+ path_params = {}
+
+ query_params = []
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'body' in params:
+ body_params = params['body']
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.select_header_accept(
+ ['application/json']) # noqa: E501
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
+ ['application/json']) # noqa: E501
+
+ # Authentication setting
+ auth_settings = [] # noqa: E501
+
+ return self.api_client.call_api(
+ '/createBloxbergCertificate', 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='list[ControllerCertToolsGenerateUnsignedCertificateJsonCertificate]', # noqa: E501
+ auth_settings=auth_settings,
+ async_req=params.get('async_req'),
+ _return_http_data_only=params.get('_return_http_data_only'),
+ _preload_content=params.get('_preload_content', True),
+ _request_timeout=params.get('_request_timeout'),
+ collection_formats=collection_formats)
diff --git a/src/caosadvancedtools/bloxberg/swagger_client/api/pdf_api.py b/src/caosadvancedtools/bloxberg/swagger_client/api/pdf_api.py
new file mode 100644
index 0000000000000000000000000000000000000000..a5a279de21e45735be31eed1ce18fd7c275cf6cb
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/swagger_client/api/pdf_api.py
@@ -0,0 +1,132 @@
+# coding: utf-8
+
+"""
+ Research Object Certification
+
+ No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
+
+ OpenAPI spec version: 0.2.0
+
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+import re # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from swagger_client.api_client import ApiClient
+
+
+class PdfApi(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ Ref: https://github.com/swagger-api/swagger-codegen
+ """
+
+ def __init__(self, api_client=None):
+ if api_client is None:
+ api_client = ApiClient()
+ self.api_client = api_client
+
+ def generate_pdf_generate_pdf_post(self, body, **kwargs): # noqa: E501
+ """Generatepdf # noqa: E501
+
+ Accepts as input the response from the createBloxbergCertificate endpoint, for example a research object JSON array. Returns as response a zip archive with PDF files that correspond to the number of cryptographic identifiers provided. PDF files are embedded with the Research Object Certification which is used for verification. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.generate_pdf_generate_pdf_post(body, async_req=True)
+ >>> result = thread.get()
+
+ :param async_req bool
+ :param list[ControllerCertToolsGeneratePdfJsonCertificate] body: (required)
+ :return: Object
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('async_req'):
+ return self.generate_pdf_generate_pdf_post_with_http_info(body, **kwargs) # noqa: E501
+ else:
+ (data) = self.generate_pdf_generate_pdf_post_with_http_info(body, **kwargs) # noqa: E501
+ return data
+
+ def generate_pdf_generate_pdf_post_with_http_info(self, body, **kwargs): # noqa: E501
+ """Generatepdf # noqa: E501
+
+ Accepts as input the response from the createBloxbergCertificate endpoint, for example a research object JSON array. Returns as response a zip archive with PDF files that correspond to the number of cryptographic identifiers provided. PDF files are embedded with the Research Object Certification which is used for verification. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.generate_pdf_generate_pdf_post_with_http_info(body, async_req=True)
+ >>> result = thread.get()
+
+ :param async_req bool
+ :param list[ControllerCertToolsGeneratePdfJsonCertificate] body: (required)
+ :return: Object
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['body'] # noqa: E501
+ all_params.append('async_req')
+ all_params.append('_return_http_data_only')
+ all_params.append('_preload_content')
+ all_params.append('_request_timeout')
+
+ params = locals()
+ for key, val in six.iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method generate_pdf_generate_pdf_post" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the required parameter 'body' is set
+ if ('body' not in params or
+ params['body'] is None):
+ raise ValueError("Missing the required parameter `body` when calling `generate_pdf_generate_pdf_post`") # noqa: E501
+
+ collection_formats = {}
+
+ path_params = {}
+
+ query_params = []
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'body' in params:
+ body_params = params['body']
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.select_header_accept(
+ ['application/json']) # noqa: E501
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
+ ['application/json']) # noqa: E501
+
+ # Authentication setting
+ auth_settings = [] # noqa: E501
+
+ return self.api_client.call_api(
+ '/generatePDF', 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='Object', # noqa: E501
+ auth_settings=auth_settings,
+ async_req=params.get('async_req'),
+ _return_http_data_only=params.get('_return_http_data_only'),
+ _preload_content=params.get('_preload_content', True),
+ _request_timeout=params.get('_request_timeout'),
+ collection_formats=collection_formats)
diff --git a/src/caosadvancedtools/bloxberg/swagger_client/api_client.py b/src/caosadvancedtools/bloxberg/swagger_client/api_client.py
new file mode 100644
index 0000000000000000000000000000000000000000..25e6501a4e36b09bca266f2eb375807053a58870
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/swagger_client/api_client.py
@@ -0,0 +1,628 @@
+# coding: utf-8
+"""
+ Research Object Certification
+
+ No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
+
+ OpenAPI spec version: 0.2.0
+
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+from __future__ import absolute_import
+
+import datetime
+import json
+import mimetypes
+from multiprocessing.pool import ThreadPool
+import os
+import re
+import tempfile
+
+# python 2 and python 3 compatibility library
+import six
+from six.moves.urllib.parse import quote
+
+from swagger_client.configuration import Configuration
+import swagger_client.models
+from swagger_client import rest
+
+
+class ApiClient(object):
+ """Generic API client for Swagger client library builds.
+
+ Swagger generic API client. This client handles the client-
+ server communication, and is invariant across implementations. Specifics of
+ the methods and models for each application are generated from the Swagger
+ templates.
+
+ NOTE: This class is auto generated by the swagger code generator program.
+ Ref: https://github.com/swagger-api/swagger-codegen
+ Do not edit the class manually.
+
+ :param configuration: .Configuration object for this client
+ :param header_name: a header to pass when making calls to the API.
+ :param header_value: a header value to pass when making calls to
+ the API.
+ :param cookie: a cookie to include in the header when making calls
+ to the API
+ """
+
+ PRIMITIVE_TYPES = (float, bool, bytes, six.text_type) + six.integer_types
+ NATIVE_TYPES_MAPPING = {
+ 'int': int,
+ 'long': int if six.PY3 else long, # noqa: F821
+ 'float': float,
+ 'str': str,
+ 'bool': bool,
+ 'date': datetime.date,
+ 'datetime': datetime.datetime,
+ 'object': object,
+ }
+
+ def __init__(self, configuration=None, header_name=None, header_value=None,
+ cookie=None):
+ if configuration is None:
+ configuration = Configuration()
+ self.configuration = configuration
+
+ self.pool = ThreadPool()
+ self.rest_client = rest.RESTClientObject(configuration)
+ self.default_headers = {}
+ if header_name is not None:
+ self.default_headers[header_name] = header_value
+ self.cookie = cookie
+ # Set default User-Agent.
+ self.user_agent = 'Swagger-Codegen/1.0.0/python'
+
+ def __del__(self):
+ self.pool.close()
+ self.pool.join()
+
+ @property
+ def user_agent(self):
+ """User agent for this API client"""
+ return self.default_headers['User-Agent']
+
+ @user_agent.setter
+ def user_agent(self, value):
+ self.default_headers['User-Agent'] = value
+
+ def set_default_header(self, header_name, header_value):
+ self.default_headers[header_name] = header_value
+
+ def __call_api(
+ self, resource_path, method, path_params=None,
+ query_params=None, header_params=None, body=None, post_params=None,
+ files=None, response_type=None, auth_settings=None,
+ _return_http_data_only=None, collection_formats=None,
+ _preload_content=True, _request_timeout=None):
+
+ config = self.configuration
+
+ # header parameters
+ header_params = header_params or {}
+ header_params.update(self.default_headers)
+ if self.cookie:
+ header_params['Cookie'] = self.cookie
+ if header_params:
+ header_params = self.sanitize_for_serialization(header_params)
+ header_params = dict(self.parameters_to_tuples(header_params,
+ collection_formats))
+
+ # path parameters
+ if path_params:
+ path_params = self.sanitize_for_serialization(path_params)
+ path_params = self.parameters_to_tuples(path_params,
+ collection_formats)
+ for k, v in path_params:
+ # specified safe chars, encode everything
+ resource_path = resource_path.replace(
+ '{%s}' % k,
+ quote(str(v), safe=config.safe_chars_for_path_param)
+ )
+
+ # query parameters
+ if query_params:
+ query_params = self.sanitize_for_serialization(query_params)
+ query_params = self.parameters_to_tuples(query_params,
+ collection_formats)
+
+ # post parameters
+ if post_params or files:
+ post_params = self.prepare_post_parameters(post_params, files)
+ post_params = self.sanitize_for_serialization(post_params)
+ post_params = self.parameters_to_tuples(post_params,
+ collection_formats)
+
+ # auth setting
+ self.update_params_for_auth(header_params, query_params, auth_settings)
+
+ # body
+ if body:
+ body = self.sanitize_for_serialization(body)
+
+ # request url
+ url = self.configuration.host + resource_path
+
+ # perform request and return response
+ response_data = self.request(
+ method, url, query_params=query_params, headers=header_params,
+ post_params=post_params, body=body,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout)
+
+ self.last_response = response_data
+
+ return_data = response_data
+ if _preload_content:
+ # deserialize response data
+ if response_type:
+ return_data = self.deserialize(response_data, response_type)
+ else:
+ return_data = None
+
+ if _return_http_data_only:
+ return (return_data)
+ else:
+ return (return_data, response_data.status,
+ response_data.getheaders())
+
+ def sanitize_for_serialization(self, obj):
+ """Builds a JSON POST object.
+
+ If obj is None, return None.
+ If obj is str, int, long, float, bool, return directly.
+ If obj is datetime.datetime, datetime.date
+ convert to string in iso8601 format.
+ If obj is list, sanitize each element in the list.
+ If obj is dict, return the dict.
+ If obj is swagger model, return the properties dict.
+
+ :param obj: The data to serialize.
+ :return: The serialized form of data.
+ """
+ if obj is None:
+ return None
+ elif isinstance(obj, self.PRIMITIVE_TYPES):
+ return obj
+ elif isinstance(obj, list):
+ return [self.sanitize_for_serialization(sub_obj)
+ for sub_obj in obj]
+ elif isinstance(obj, tuple):
+ return tuple(self.sanitize_for_serialization(sub_obj)
+ for sub_obj in obj)
+ elif isinstance(obj, (datetime.datetime, datetime.date)):
+ return obj.isoformat()
+
+ if isinstance(obj, dict):
+ obj_dict = obj
+ else:
+ # Convert model obj to dict except
+ # attributes `swagger_types`, `attribute_map`
+ # and attributes which value is not None.
+ # Convert attribute name to json key in
+ # model definition for request.
+ obj_dict = {obj.attribute_map[attr]: getattr(obj, attr)
+ for attr, _ in six.iteritems(obj.swagger_types)
+ if getattr(obj, attr) is not None}
+
+ return {key: self.sanitize_for_serialization(val)
+ for key, val in six.iteritems(obj_dict)}
+
+ def deserialize(self, response, response_type):
+ """Deserializes response into an object.
+
+ :param response: RESTResponse object to be deserialized.
+ :param response_type: class literal for
+ deserialized object, or string of class name.
+
+ :return: deserialized object.
+ """
+ # handle file downloading
+ # save response body into a tmp file and return the instance
+ if response_type == "file":
+ return self.__deserialize_file(response)
+
+ # fetch data from response object
+ try:
+ data = json.loads(response.data)
+ except ValueError:
+ data = response.data
+
+ return self.__deserialize(data, response_type)
+
+ def __deserialize(self, data, klass):
+ """Deserializes dict, list, str into an object.
+
+ :param data: dict, list or str.
+ :param klass: class literal, or string of class name.
+
+ :return: object.
+ """
+ if data is None:
+ return None
+
+ if type(klass) == str:
+ if klass.startswith('list['):
+ sub_kls = re.match(r'list\[(.*)\]', klass).group(1)
+ return [self.__deserialize(sub_data, sub_kls)
+ for sub_data in data]
+
+ if klass.startswith('dict('):
+ sub_kls = re.match(r'dict\(([^,]*), (.*)\)', klass).group(2)
+ return {k: self.__deserialize(v, sub_kls)
+ for k, v in six.iteritems(data)}
+
+ # convert str to class
+ if klass in self.NATIVE_TYPES_MAPPING:
+ klass = self.NATIVE_TYPES_MAPPING[klass]
+ else:
+ klass = getattr(swagger_client.models, klass)
+
+ if klass in self.PRIMITIVE_TYPES:
+ return self.__deserialize_primitive(data, klass)
+ elif klass == object:
+ return self.__deserialize_object(data)
+ elif klass == datetime.date:
+ return self.__deserialize_date(data)
+ elif klass == datetime.datetime:
+ return self.__deserialize_datatime(data)
+ else:
+ return self.__deserialize_model(data, klass)
+
+ def call_api(self, resource_path, method,
+ path_params=None, query_params=None, header_params=None,
+ body=None, post_params=None, files=None,
+ response_type=None, auth_settings=None, async_req=None,
+ _return_http_data_only=None, collection_formats=None,
+ _preload_content=True, _request_timeout=None):
+ """Makes the HTTP request (synchronous) and returns deserialized data.
+
+ To make an async request, set the async_req parameter.
+
+ :param resource_path: Path to method endpoint.
+ :param method: Method to call.
+ :param path_params: Path parameters in the url.
+ :param query_params: Query parameters in the url.
+ :param header_params: Header parameters to be
+ placed in the request header.
+ :param body: Request body.
+ :param post_params dict: Request post form parameters,
+ for `application/x-www-form-urlencoded`, `multipart/form-data`.
+ :param auth_settings list: Auth Settings names for the request.
+ :param response: Response data type.
+ :param files dict: key -> filename, value -> filepath,
+ for `multipart/form-data`.
+ :param async_req bool: execute request asynchronously
+ :param _return_http_data_only: response data without head status code
+ and headers
+ :param collection_formats: dict of collection formats for path, query,
+ header, and post parameters.
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :return:
+ If async_req parameter is True,
+ the request will be called asynchronously.
+ The method will return the request thread.
+ If parameter async_req is False or missing,
+ then the method will return the response directly.
+ """
+ if not async_req:
+ return self.__call_api(resource_path, method,
+ path_params, query_params, header_params,
+ body, post_params, files,
+ response_type, auth_settings,
+ _return_http_data_only, collection_formats,
+ _preload_content, _request_timeout)
+ else:
+ thread = self.pool.apply_async(self.__call_api, (resource_path,
+ method, path_params, query_params,
+ header_params, body,
+ post_params, files,
+ response_type, auth_settings,
+ _return_http_data_only,
+ collection_formats,
+ _preload_content, _request_timeout))
+ return thread
+
+ def request(self, method, url, query_params=None, headers=None,
+ post_params=None, body=None, _preload_content=True,
+ _request_timeout=None):
+ """Makes the HTTP request using RESTClient."""
+ if method == "GET":
+ return self.rest_client.GET(url,
+ query_params=query_params,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout,
+ headers=headers)
+ elif method == "HEAD":
+ return self.rest_client.HEAD(url,
+ query_params=query_params,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout,
+ headers=headers)
+ elif method == "OPTIONS":
+ return self.rest_client.OPTIONS(url,
+ query_params=query_params,
+ headers=headers,
+ post_params=post_params,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout,
+ body=body)
+ elif method == "POST":
+ return self.rest_client.POST(url,
+ query_params=query_params,
+ headers=headers,
+ post_params=post_params,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout,
+ body=body)
+ elif method == "PUT":
+ return self.rest_client.PUT(url,
+ query_params=query_params,
+ headers=headers,
+ post_params=post_params,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout,
+ body=body)
+ elif method == "PATCH":
+ return self.rest_client.PATCH(url,
+ query_params=query_params,
+ headers=headers,
+ post_params=post_params,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout,
+ body=body)
+ elif method == "DELETE":
+ return self.rest_client.DELETE(url,
+ query_params=query_params,
+ headers=headers,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout,
+ body=body)
+ else:
+ raise ValueError(
+ "http method must be `GET`, `HEAD`, `OPTIONS`,"
+ " `POST`, `PATCH`, `PUT` or `DELETE`."
+ )
+
+ def parameters_to_tuples(self, params, collection_formats):
+ """Get parameters as list of tuples, formatting collections.
+
+ :param params: Parameters as dict or list of two-tuples
+ :param dict collection_formats: Parameter collection formats
+ :return: Parameters as list of tuples, collections formatted
+ """
+ new_params = []
+ if collection_formats is None:
+ collection_formats = {}
+ for k, v in six.iteritems(params) if isinstance(params, dict) else params: # noqa: E501
+ if k in collection_formats:
+ collection_format = collection_formats[k]
+ if collection_format == 'multi':
+ new_params.extend((k, value) for value in v)
+ else:
+ if collection_format == 'ssv':
+ delimiter = ' '
+ elif collection_format == 'tsv':
+ delimiter = '\t'
+ elif collection_format == 'pipes':
+ delimiter = '|'
+ else: # csv is the default
+ delimiter = ','
+ new_params.append(
+ (k, delimiter.join(str(value) for value in v)))
+ else:
+ new_params.append((k, v))
+ return new_params
+
+ def prepare_post_parameters(self, post_params=None, files=None):
+ """Builds form parameters.
+
+ :param post_params: Normal form parameters.
+ :param files: File parameters.
+ :return: Form parameters with files.
+ """
+ params = []
+
+ if post_params:
+ params = post_params
+
+ if files:
+ for k, v in six.iteritems(files):
+ if not v:
+ continue
+ file_names = v if type(v) is list else [v]
+ for n in file_names:
+ with open(n, 'rb') as f:
+ filename = os.path.basename(f.name)
+ filedata = f.read()
+ mimetype = (mimetypes.guess_type(filename)[0] or
+ 'application/octet-stream')
+ params.append(
+ tuple([k, tuple([filename, filedata, mimetype])]))
+
+ return params
+
+ def select_header_accept(self, accepts):
+ """Returns `Accept` based on an array of accepts provided.
+
+ :param accepts: List of headers.
+ :return: Accept (e.g. application/json).
+ """
+ if not accepts:
+ return
+
+ accepts = [x.lower() for x in accepts]
+
+ if 'application/json' in accepts:
+ return 'application/json'
+ else:
+ return ', '.join(accepts)
+
+ def select_header_content_type(self, content_types):
+ """Returns `Content-Type` based on an array of content_types provided.
+
+ :param content_types: List of content-types.
+ :return: Content-Type (e.g. application/json).
+ """
+ if not content_types:
+ return 'application/json'
+
+ content_types = [x.lower() for x in content_types]
+
+ if 'application/json' in content_types or '*/*' in content_types:
+ return 'application/json'
+ else:
+ return content_types[0]
+
+ def update_params_for_auth(self, headers, querys, auth_settings):
+ """Updates header and query params based on authentication setting.
+
+ :param headers: Header parameters dict to be updated.
+ :param querys: Query parameters tuple list to be updated.
+ :param auth_settings: Authentication setting identifiers list.
+ """
+ if not auth_settings:
+ return
+
+ for auth in auth_settings:
+ auth_setting = self.configuration.auth_settings().get(auth)
+ if auth_setting:
+ if not auth_setting['value']:
+ continue
+ elif auth_setting['in'] == 'header':
+ headers[auth_setting['key']] = auth_setting['value']
+ elif auth_setting['in'] == 'query':
+ querys.append((auth_setting['key'], auth_setting['value']))
+ else:
+ raise ValueError(
+ 'Authentication token must be in `query` or `header`'
+ )
+
+ def __deserialize_file(self, response):
+ """Deserializes body to file
+
+ Saves response body into a file in a temporary folder,
+ using the filename from the `Content-Disposition` header if provided.
+
+ :param response: RESTResponse.
+ :return: file path.
+ """
+ fd, path = tempfile.mkstemp(dir=self.configuration.temp_folder_path)
+ os.close(fd)
+ os.remove(path)
+
+ content_disposition = response.getheader("Content-Disposition")
+ if content_disposition:
+ filename = re.search(r'filename=[\'"]?([^\'"\s]+)[\'"]?',
+ content_disposition).group(1)
+ path = os.path.join(os.path.dirname(path), filename)
+
+ with open(path, "wb") as f:
+ f.write(response.data)
+
+ return path
+
+ def __deserialize_primitive(self, data, klass):
+ """Deserializes string to primitive type.
+
+ :param data: str.
+ :param klass: class literal.
+
+ :return: int, long, float, str, bool.
+ """
+ try:
+ return klass(data)
+ except UnicodeEncodeError:
+ return six.text_type(data)
+ except TypeError:
+ return data
+
+ def __deserialize_object(self, value):
+ """Return a original value.
+
+ :return: object.
+ """
+ return value
+
+ def __deserialize_date(self, string):
+ """Deserializes string to date.
+
+ :param string: str.
+ :return: date.
+ """
+ try:
+ from dateutil.parser import parse
+ return parse(string).date()
+ except ImportError:
+ return string
+ except ValueError:
+ raise rest.ApiException(
+ status=0,
+ reason="Failed to parse `{0}` as date object".format(string)
+ )
+
+ def __deserialize_datatime(self, string):
+ """Deserializes string to datetime.
+
+ The string should be in iso8601 datetime format.
+
+ :param string: str.
+ :return: datetime.
+ """
+ try:
+ from dateutil.parser import parse
+ return parse(string)
+ except ImportError:
+ return string
+ except ValueError:
+ raise rest.ApiException(
+ status=0,
+ reason=(
+ "Failed to parse `{0}` as datetime object"
+ .format(string)
+ )
+ )
+
+ def __hasattr(self, object, name):
+ return name in object.__class__.__dict__
+
+ def __deserialize_model(self, data, klass):
+ """Deserializes list or dict to model.
+
+ :param data: dict, list.
+ :param klass: class literal.
+ :return: model object.
+ """
+
+ if not klass.swagger_types and not self.__hasattr(klass, 'get_real_child_model'):
+ return data
+
+ kwargs = {}
+ if klass.swagger_types is not None:
+ for attr, attr_type in six.iteritems(klass.swagger_types):
+ if (data is not None and
+ klass.attribute_map[attr] in data and
+ isinstance(data, (list, dict))):
+ value = data[klass.attribute_map[attr]]
+ kwargs[attr] = self.__deserialize(value, attr_type)
+
+ instance = klass(**kwargs)
+
+ if (isinstance(instance, dict) and
+ klass.swagger_types is not None and
+ isinstance(data, dict)):
+ for key, value in data.items():
+ if key not in klass.swagger_types:
+ instance[key] = value
+ if self.__hasattr(instance, 'get_real_child_model'):
+ klass_name = instance.get_real_child_model(data)
+ if klass_name:
+ instance = self.__deserialize(data, klass_name)
+ return instance
diff --git a/src/caosadvancedtools/bloxberg/swagger_client/configuration.py b/src/caosadvancedtools/bloxberg/swagger_client/configuration.py
new file mode 100644
index 0000000000000000000000000000000000000000..2be9f6a733a030d0dea2ab43b9e85f6ed15085d8
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/swagger_client/configuration.py
@@ -0,0 +1,244 @@
+# coding: utf-8
+
+"""
+ Research Object Certification
+
+ No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
+
+ OpenAPI spec version: 0.2.0
+
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+import copy
+import logging
+import multiprocessing
+import sys
+import urllib3
+
+import six
+from six.moves import http_client as httplib
+
+
+class TypeWithDefault(type):
+ def __init__(cls, name, bases, dct):
+ super(TypeWithDefault, cls).__init__(name, bases, dct)
+ cls._default = None
+
+ def __call__(cls):
+ if cls._default is None:
+ cls._default = type.__call__(cls)
+ return copy.copy(cls._default)
+
+ def set_default(cls, default):
+ cls._default = copy.copy(default)
+
+
+class Configuration(six.with_metaclass(TypeWithDefault, object)):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+ Do not edit the class manually.
+ """
+
+ def __init__(self):
+ """Constructor"""
+ # Default Base url
+ self.host = "https://qa.certify.bloxberg.org"
+ # Temp file folder for downloading files
+ self.temp_folder_path = None
+
+ # Authentication Settings
+ # dict to store API key(s)
+ self.api_key = {}
+ # dict to store API prefix (e.g. Bearer)
+ self.api_key_prefix = {}
+ # function to refresh API key if expired
+ self.refresh_api_key_hook = None
+ # Username for HTTP basic authentication
+ self.username = ""
+ # Password for HTTP basic authentication
+ self.password = ""
+ # Logging Settings
+ self.logger = {}
+ self.logger["package_logger"] = logging.getLogger("swagger_client")
+ self.logger["urllib3_logger"] = logging.getLogger("urllib3")
+ # Log format
+ self.logger_format = '%(asctime)s %(levelname)s %(message)s'
+ # Log stream handler
+ self.logger_stream_handler = None
+ # Log file handler
+ self.logger_file_handler = None
+ # Debug file location
+ self.logger_file = None
+ # Debug switch
+ self.debug = False
+
+ # SSL/TLS verification
+ # Set this to false to skip verifying SSL certificate when calling API
+ # from https server.
+ self.verify_ssl = True
+ # Set this to customize the certificate file to verify the peer.
+ self.ssl_ca_cert = None
+ # client certificate file
+ self.cert_file = None
+ # client key file
+ self.key_file = None
+ # Set this to True/False to enable/disable SSL hostname verification.
+ self.assert_hostname = None
+
+ # urllib3 connection pool's maximum number of connections saved
+ # per pool. urllib3 uses 1 connection as default value, but this is
+ # not the best value when you are making a lot of possibly parallel
+ # requests to the same host, which is often the case here.
+ # cpu_count * 5 is used as default value to increase performance.
+ self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
+
+ # Proxy URL
+ self.proxy = None
+ # Safe chars for path_param
+ self.safe_chars_for_path_param = ''
+
+ @property
+ def logger_file(self):
+ """The logger file.
+
+ If the logger_file is None, then add stream handler and remove file
+ handler. Otherwise, add file handler and remove stream handler.
+
+ :param value: The logger_file path.
+ :type: str
+ """
+ return self.__logger_file
+
+ @logger_file.setter
+ def logger_file(self, value):
+ """The logger file.
+
+ If the logger_file is None, then add stream handler and remove file
+ handler. Otherwise, add file handler and remove stream handler.
+
+ :param value: The logger_file path.
+ :type: str
+ """
+ self.__logger_file = value
+ if self.__logger_file:
+ # If set logging file,
+ # then add file handler and remove stream handler.
+ self.logger_file_handler = logging.FileHandler(self.__logger_file)
+ self.logger_file_handler.setFormatter(self.logger_formatter)
+ for _, logger in six.iteritems(self.logger):
+ logger.addHandler(self.logger_file_handler)
+ if self.logger_stream_handler:
+ logger.removeHandler(self.logger_stream_handler)
+ else:
+ # If not set logging file,
+ # then add stream handler and remove file handler.
+ self.logger_stream_handler = logging.StreamHandler()
+ self.logger_stream_handler.setFormatter(self.logger_formatter)
+ for _, logger in six.iteritems(self.logger):
+ logger.addHandler(self.logger_stream_handler)
+ if self.logger_file_handler:
+ logger.removeHandler(self.logger_file_handler)
+
+ @property
+ def debug(self):
+ """Debug status
+
+ :param value: The debug status, True or False.
+ :type: bool
+ """
+ return self.__debug
+
+ @debug.setter
+ def debug(self, value):
+ """Debug status
+
+ :param value: The debug status, True or False.
+ :type: bool
+ """
+ self.__debug = value
+ if self.__debug:
+ # if debug status is True, turn on debug logging
+ for _, logger in six.iteritems(self.logger):
+ logger.setLevel(logging.DEBUG)
+ # turn on httplib debug
+ httplib.HTTPConnection.debuglevel = 1
+ else:
+ # if debug status is False, turn off debug logging,
+ # setting log level to default `logging.WARNING`
+ for _, logger in six.iteritems(self.logger):
+ logger.setLevel(logging.WARNING)
+ # turn off httplib debug
+ httplib.HTTPConnection.debuglevel = 0
+
+ @property
+ def logger_format(self):
+ """The logger format.
+
+ The logger_formatter will be updated when sets logger_format.
+
+ :param value: The format string.
+ :type: str
+ """
+ return self.__logger_format
+
+ @logger_format.setter
+ def logger_format(self, value):
+ """The logger format.
+
+ The logger_formatter will be updated when sets logger_format.
+
+ :param value: The format string.
+ :type: str
+ """
+ self.__logger_format = value
+ self.logger_formatter = logging.Formatter(self.__logger_format)
+
+ def get_api_key_with_prefix(self, identifier):
+ """Gets API key (with prefix if set).
+
+ :param identifier: The identifier of apiKey.
+ :return: The token for api key authentication.
+ """
+ if self.refresh_api_key_hook:
+ self.refresh_api_key_hook(self)
+
+ key = self.api_key.get(identifier)
+ if key:
+ prefix = self.api_key_prefix.get(identifier)
+ if prefix:
+ return "%s %s" % (prefix, key)
+ else:
+ return key
+
+ def get_basic_auth_token(self):
+ """Gets HTTP basic authentication header (string).
+
+ :return: The token for basic HTTP authentication.
+ """
+ return urllib3.util.make_headers(
+ basic_auth=self.username + ':' + self.password
+ ).get('authorization')
+
+ def auth_settings(self):
+ """Gets Auth Settings dict for api client.
+
+ :return: The Auth Settings information dict.
+ """
+ return {
+ }
+
+ def to_debug_report(self):
+ """Gets the essential information for debugging.
+
+ :return: The report for debugging.
+ """
+ return "Python SDK Debug Report:\n"\
+ "OS: {env}\n"\
+ "Python Version: {pyversion}\n"\
+ "Version of the API: 0.2.0\n"\
+ "SDK Package Version: 1.0.0".\
+ format(env=sys.platform, pyversion=sys.version)
diff --git a/src/caosadvancedtools/bloxberg/swagger_client/models/__init__.py b/src/caosadvancedtools/bloxberg/swagger_client/models/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..55b01c66f4f68f86ea6fd8bc34e61fc534d3902f
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/swagger_client/models/__init__.py
@@ -0,0 +1,21 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+ Research Object Certification
+
+ No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
+
+ OpenAPI spec version: 0.2.0
+
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+# import models into model package
+from swagger_client.models.batch import Batch
+from swagger_client.models.controller_cert_tools_generate_pdf_json_certificate import ControllerCertToolsGeneratePdfJsonCertificate
+from swagger_client.models.controller_cert_tools_generate_unsigned_certificate_json_certificate import ControllerCertToolsGenerateUnsignedCertificateJsonCertificate
+from swagger_client.models.http_validation_error import HTTPValidationError
+from swagger_client.models.validation_error import ValidationError
diff --git a/src/caosadvancedtools/bloxberg/swagger_client/models/batch.py b/src/caosadvancedtools/bloxberg/swagger_client/models/batch.py
new file mode 100644
index 0000000000000000000000000000000000000000..7a347cf7ac9148df8ec9a43200f4058f127447b9
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/swagger_client/models/batch.py
@@ -0,0 +1,227 @@
+# coding: utf-8
+
+"""
+ Research Object Certification
+
+ No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
+
+ OpenAPI spec version: 0.2.0
+
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+import pprint
+import re # noqa: F401
+
+import six
+
+class Batch(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'public_key': 'str',
+ 'crid': 'list[str]',
+ 'crid_type': 'str',
+ 'enable_ipfs': 'bool',
+ 'metadata_json': 'str'
+ }
+
+ attribute_map = {
+ 'public_key': 'publicKey',
+ 'crid': 'crid',
+ 'crid_type': 'cridType',
+ 'enable_ipfs': 'enableIPFS',
+ 'metadata_json': 'metadataJson'
+ }
+
+ def __init__(self, public_key=None, crid=None, crid_type=None, enable_ipfs=None, metadata_json=None): # noqa: E501
+ """Batch - a model defined in Swagger""" # noqa: E501
+ self._public_key = None
+ self._crid = None
+ self._crid_type = None
+ self._enable_ipfs = None
+ self._metadata_json = None
+ self.discriminator = None
+ self.public_key = public_key
+ self.crid = crid
+ if crid_type is not None:
+ self.crid_type = crid_type
+ self.enable_ipfs = enable_ipfs
+ if metadata_json is not None:
+ self.metadata_json = metadata_json
+
+ @property
+ def public_key(self):
+ """Gets the public_key of this Batch. # noqa: E501
+
+ Public bloxberg address where the Research Object Certificate token will be minted # noqa: E501
+
+ :return: The public_key of this Batch. # noqa: E501
+ :rtype: str
+ """
+ return self._public_key
+
+ @public_key.setter
+ def public_key(self, public_key):
+ """Sets the public_key of this Batch.
+
+ Public bloxberg address where the Research Object Certificate token will be minted # noqa: E501
+
+ :param public_key: The public_key of this Batch. # noqa: E501
+ :type: str
+ """
+ if public_key is None:
+ raise ValueError("Invalid value for `public_key`, must not be `None`") # noqa: E501
+
+ self._public_key = public_key
+
+ @property
+ def crid(self):
+ """Gets the crid of this Batch. # noqa: E501
+
+ Cryptographic Identifier of each file you wish to certify. One certificate will be generated per hash up to a maximum of 1001 in a single request # noqa: E501
+
+ :return: The crid of this Batch. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._crid
+
+ @crid.setter
+ def crid(self, crid):
+ """Sets the crid of this Batch.
+
+ Cryptographic Identifier of each file you wish to certify. One certificate will be generated per hash up to a maximum of 1001 in a single request # noqa: E501
+
+ :param crid: The crid of this Batch. # noqa: E501
+ :type: list[str]
+ """
+ if crid is None:
+ raise ValueError("Invalid value for `crid`, must not be `None`") # noqa: E501
+
+ self._crid = crid
+
+ @property
+ def crid_type(self):
+ """Gets the crid_type of this Batch. # noqa: E501
+
+ If crid is not self-describing, provide the type of cryptographic function you used to generate the cryptographic identifier. Please use the name field from the multihash list to ensure compatibility: https://github.com/multiformats/multicodec/blob/master/table.csv # noqa: E501
+
+ :return: The crid_type of this Batch. # noqa: E501
+ :rtype: str
+ """
+ return self._crid_type
+
+ @crid_type.setter
+ def crid_type(self, crid_type):
+ """Sets the crid_type of this Batch.
+
+ If crid is not self-describing, provide the type of cryptographic function you used to generate the cryptographic identifier. Please use the name field from the multihash list to ensure compatibility: https://github.com/multiformats/multicodec/blob/master/table.csv # noqa: E501
+
+ :param crid_type: The crid_type of this Batch. # noqa: E501
+ :type: str
+ """
+
+ self._crid_type = crid_type
+
+ @property
+ def enable_ipfs(self):
+ """Gets the enable_ipfs of this Batch. # noqa: E501
+
+ EXPERIMENTAL: Set to true to enable posting certificate to IPFS. If set to false, will simply return certificates in the response. By default, this is disabled on the server due to performance and storage problems with IPFS # noqa: E501
+
+ :return: The enable_ipfs of this Batch. # noqa: E501
+ :rtype: bool
+ """
+ return self._enable_ipfs
+
+ @enable_ipfs.setter
+ def enable_ipfs(self, enable_ipfs):
+ """Sets the enable_ipfs of this Batch.
+
+ EXPERIMENTAL: Set to true to enable posting certificate to IPFS. If set to false, will simply return certificates in the response. By default, this is disabled on the server due to performance and storage problems with IPFS # noqa: E501
+
+ :param enable_ipfs: The enable_ipfs of this Batch. # noqa: E501
+ :type: bool
+ """
+ if enable_ipfs is None:
+ raise ValueError("Invalid value for `enable_ipfs`, must not be `None`") # noqa: E501
+
+ self._enable_ipfs = enable_ipfs
+
+ @property
+ def metadata_json(self):
+ """Gets the metadata_json of this Batch. # noqa: E501
+
+ Provide optional metadata to describe the research object batch in more detail that will be included in the certificate. # noqa: E501
+
+ :return: The metadata_json of this Batch. # noqa: E501
+ :rtype: str
+ """
+ return self._metadata_json
+
+ @metadata_json.setter
+ def metadata_json(self, metadata_json):
+ """Sets the metadata_json of this Batch.
+
+ Provide optional metadata to describe the research object batch in more detail that will be included in the certificate. # noqa: E501
+
+ :param metadata_json: The metadata_json of this Batch. # noqa: E501
+ :type: str
+ """
+
+ self._metadata_json = metadata_json
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(Batch, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, Batch):
+ return False
+
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ return not self == other
diff --git a/src/caosadvancedtools/bloxberg/swagger_client/models/controller_cert_tools_generate_pdf_json_certificate.py b/src/caosadvancedtools/bloxberg/swagger_client/models/controller_cert_tools_generate_pdf_json_certificate.py
new file mode 100644
index 0000000000000000000000000000000000000000..2d7fd2d763ba40c9a384203301aa3e70efdf7783
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/swagger_client/models/controller_cert_tools_generate_pdf_json_certificate.py
@@ -0,0 +1,379 @@
+# coding: utf-8
+
+"""
+ Research Object Certification
+
+ No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
+
+ OpenAPI spec version: 0.2.0
+
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+import pprint
+import re # noqa: F401
+
+import six
+
+class ControllerCertToolsGeneratePdfJsonCertificate(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'context': 'list[str]',
+ 'id': 'str',
+ 'type': 'list[str]',
+ 'issuer': 'str',
+ 'issuance_date': 'str',
+ 'credential_subject': 'object',
+ 'display_html': 'str',
+ 'crid': 'str',
+ 'crid_type': 'str',
+ 'metadata_json': 'str',
+ 'proof': 'object'
+ }
+
+ attribute_map = {
+ 'context': '@context',
+ 'id': 'id',
+ 'type': 'type',
+ 'issuer': 'issuer',
+ 'issuance_date': 'issuanceDate',
+ 'credential_subject': 'credentialSubject',
+ 'display_html': 'displayHtml',
+ 'crid': 'crid',
+ 'crid_type': 'cridType',
+ 'metadata_json': 'metadataJson',
+ 'proof': 'proof'
+ }
+
+ def __init__(self, context=None, id=None, type=None, issuer=None, issuance_date=None, credential_subject=None, display_html=None, crid=None, crid_type=None, metadata_json=None, proof=None): # noqa: E501
+ """ControllerCertToolsGeneratePdfJsonCertificate - a model defined in Swagger""" # noqa: E501
+ self._context = None
+ self._id = None
+ self._type = None
+ self._issuer = None
+ self._issuance_date = None
+ self._credential_subject = None
+ self._display_html = None
+ self._crid = None
+ self._crid_type = None
+ self._metadata_json = None
+ self._proof = None
+ self.discriminator = None
+ if context is not None:
+ self.context = context
+ self.id = id
+ self.type = type
+ self.issuer = issuer
+ self.issuance_date = issuance_date
+ self.credential_subject = credential_subject
+ if display_html is not None:
+ self.display_html = display_html
+ self.crid = crid
+ if crid_type is not None:
+ self.crid_type = crid_type
+ if metadata_json is not None:
+ self.metadata_json = metadata_json
+ self.proof = proof
+
+ @property
+ def context(self):
+ """Gets the context of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+
+ Relevant JSON-LD context links in order to validate Verifiable Credentials according to their spec. # noqa: E501
+
+ :return: The context of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._context
+
+ @context.setter
+ def context(self, context):
+ """Sets the context of this ControllerCertToolsGeneratePdfJsonCertificate.
+
+ Relevant JSON-LD context links in order to validate Verifiable Credentials according to their spec. # noqa: E501
+
+ :param context: The context of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :type: list[str]
+ """
+
+ self._context = context
+
+ @property
+ def id(self):
+ """Gets the id of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+
+
+ :return: The id of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :rtype: str
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id):
+ """Sets the id of this ControllerCertToolsGeneratePdfJsonCertificate.
+
+
+ :param id: The id of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :type: str
+ """
+ if id is None:
+ raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
+
+ self._id = id
+
+ @property
+ def type(self):
+ """Gets the type of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+
+
+ :return: The type of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type):
+ """Sets the type of this ControllerCertToolsGeneratePdfJsonCertificate.
+
+
+ :param type: The type of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :type: list[str]
+ """
+ if type is None:
+ raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501
+
+ self._type = type
+
+ @property
+ def issuer(self):
+ """Gets the issuer of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+
+
+ :return: The issuer of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :rtype: str
+ """
+ return self._issuer
+
+ @issuer.setter
+ def issuer(self, issuer):
+ """Sets the issuer of this ControllerCertToolsGeneratePdfJsonCertificate.
+
+
+ :param issuer: The issuer of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :type: str
+ """
+ if issuer is None:
+ raise ValueError("Invalid value for `issuer`, must not be `None`") # noqa: E501
+
+ self._issuer = issuer
+
+ @property
+ def issuance_date(self):
+ """Gets the issuance_date of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+
+
+ :return: The issuance_date of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :rtype: str
+ """
+ return self._issuance_date
+
+ @issuance_date.setter
+ def issuance_date(self, issuance_date):
+ """Sets the issuance_date of this ControllerCertToolsGeneratePdfJsonCertificate.
+
+
+ :param issuance_date: The issuance_date of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :type: str
+ """
+ if issuance_date is None:
+ raise ValueError("Invalid value for `issuance_date`, must not be `None`") # noqa: E501
+
+ self._issuance_date = issuance_date
+
+ @property
+ def credential_subject(self):
+ """Gets the credential_subject of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+
+
+ :return: The credential_subject of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :rtype: object
+ """
+ return self._credential_subject
+
+ @credential_subject.setter
+ def credential_subject(self, credential_subject):
+ """Sets the credential_subject of this ControllerCertToolsGeneratePdfJsonCertificate.
+
+
+ :param credential_subject: The credential_subject of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :type: object
+ """
+ if credential_subject is None:
+ raise ValueError("Invalid value for `credential_subject`, must not be `None`") # noqa: E501
+
+ self._credential_subject = credential_subject
+
+ @property
+ def display_html(self):
+ """Gets the display_html of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+
+
+ :return: The display_html of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :rtype: str
+ """
+ return self._display_html
+
+ @display_html.setter
+ def display_html(self, display_html):
+ """Sets the display_html of this ControllerCertToolsGeneratePdfJsonCertificate.
+
+
+ :param display_html: The display_html of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :type: str
+ """
+
+ self._display_html = display_html
+
+ @property
+ def crid(self):
+ """Gets the crid of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+
+
+ :return: The crid of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :rtype: str
+ """
+ return self._crid
+
+ @crid.setter
+ def crid(self, crid):
+ """Sets the crid of this ControllerCertToolsGeneratePdfJsonCertificate.
+
+
+ :param crid: The crid of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :type: str
+ """
+ if crid is None:
+ raise ValueError("Invalid value for `crid`, must not be `None`") # noqa: E501
+
+ self._crid = crid
+
+ @property
+ def crid_type(self):
+ """Gets the crid_type of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+
+
+ :return: The crid_type of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :rtype: str
+ """
+ return self._crid_type
+
+ @crid_type.setter
+ def crid_type(self, crid_type):
+ """Sets the crid_type of this ControllerCertToolsGeneratePdfJsonCertificate.
+
+
+ :param crid_type: The crid_type of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :type: str
+ """
+
+ self._crid_type = crid_type
+
+ @property
+ def metadata_json(self):
+ """Gets the metadata_json of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+
+
+ :return: The metadata_json of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :rtype: str
+ """
+ return self._metadata_json
+
+ @metadata_json.setter
+ def metadata_json(self, metadata_json):
+ """Sets the metadata_json of this ControllerCertToolsGeneratePdfJsonCertificate.
+
+
+ :param metadata_json: The metadata_json of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :type: str
+ """
+
+ self._metadata_json = metadata_json
+
+ @property
+ def proof(self):
+ """Gets the proof of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+
+
+ :return: The proof of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :rtype: object
+ """
+ return self._proof
+
+ @proof.setter
+ def proof(self, proof):
+ """Sets the proof of this ControllerCertToolsGeneratePdfJsonCertificate.
+
+
+ :param proof: The proof of this ControllerCertToolsGeneratePdfJsonCertificate. # noqa: E501
+ :type: object
+ """
+ if proof is None:
+ raise ValueError("Invalid value for `proof`, must not be `None`") # noqa: E501
+
+ self._proof = proof
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(ControllerCertToolsGeneratePdfJsonCertificate, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, ControllerCertToolsGeneratePdfJsonCertificate):
+ return False
+
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ return not self == other
diff --git a/src/caosadvancedtools/bloxberg/swagger_client/models/controller_cert_tools_generate_unsigned_certificate_json_certificate.py b/src/caosadvancedtools/bloxberg/swagger_client/models/controller_cert_tools_generate_unsigned_certificate_json_certificate.py
new file mode 100644
index 0000000000000000000000000000000000000000..4a6d2d3f0e15faa8672f001e964d66c6e0a27780
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/swagger_client/models/controller_cert_tools_generate_unsigned_certificate_json_certificate.py
@@ -0,0 +1,379 @@
+# coding: utf-8
+
+"""
+ Research Object Certification
+
+ No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
+
+ OpenAPI spec version: 0.2.0
+
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+import pprint
+import re # noqa: F401
+
+import six
+
+class ControllerCertToolsGenerateUnsignedCertificateJsonCertificate(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'context': 'list[str]',
+ 'id': 'str',
+ 'type': 'list[str]',
+ 'issuer': 'str',
+ 'issuance_date': 'str',
+ 'credential_subject': 'object',
+ 'display_html': 'str',
+ 'crid': 'str',
+ 'crid_type': 'str',
+ 'metadata_json': 'str',
+ 'proof': 'object'
+ }
+
+ attribute_map = {
+ 'context': '@context',
+ 'id': 'id',
+ 'type': 'type',
+ 'issuer': 'issuer',
+ 'issuance_date': 'issuanceDate',
+ 'credential_subject': 'credentialSubject',
+ 'display_html': 'displayHtml',
+ 'crid': 'crid',
+ 'crid_type': 'cridType',
+ 'metadata_json': 'metadataJson',
+ 'proof': 'proof'
+ }
+
+ def __init__(self, context=None, id=None, type=None, issuer=None, issuance_date=None, credential_subject=None, display_html=None, crid=None, crid_type=None, metadata_json=None, proof=None): # noqa: E501
+ """ControllerCertToolsGenerateUnsignedCertificateJsonCertificate - a model defined in Swagger""" # noqa: E501
+ self._context = None
+ self._id = None
+ self._type = None
+ self._issuer = None
+ self._issuance_date = None
+ self._credential_subject = None
+ self._display_html = None
+ self._crid = None
+ self._crid_type = None
+ self._metadata_json = None
+ self._proof = None
+ self.discriminator = None
+ if context is not None:
+ self.context = context
+ self.id = id
+ self.type = type
+ self.issuer = issuer
+ self.issuance_date = issuance_date
+ self.credential_subject = credential_subject
+ if display_html is not None:
+ self.display_html = display_html
+ self.crid = crid
+ if crid_type is not None:
+ self.crid_type = crid_type
+ if metadata_json is not None:
+ self.metadata_json = metadata_json
+ self.proof = proof
+
+ @property
+ def context(self):
+ """Gets the context of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+
+ Relevant JSON-LD context links in order to validate Verifiable Credentials according to their spec. # noqa: E501
+
+ :return: The context of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._context
+
+ @context.setter
+ def context(self, context):
+ """Sets the context of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate.
+
+ Relevant JSON-LD context links in order to validate Verifiable Credentials according to their spec. # noqa: E501
+
+ :param context: The context of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :type: list[str]
+ """
+
+ self._context = context
+
+ @property
+ def id(self):
+ """Gets the id of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+
+
+ :return: The id of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :rtype: str
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id):
+ """Sets the id of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate.
+
+
+ :param id: The id of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :type: str
+ """
+ if id is None:
+ raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
+
+ self._id = id
+
+ @property
+ def type(self):
+ """Gets the type of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+
+
+ :return: The type of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type):
+ """Sets the type of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate.
+
+
+ :param type: The type of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :type: list[str]
+ """
+ if type is None:
+ raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501
+
+ self._type = type
+
+ @property
+ def issuer(self):
+ """Gets the issuer of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+
+
+ :return: The issuer of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :rtype: str
+ """
+ return self._issuer
+
+ @issuer.setter
+ def issuer(self, issuer):
+ """Sets the issuer of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate.
+
+
+ :param issuer: The issuer of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :type: str
+ """
+ if issuer is None:
+ raise ValueError("Invalid value for `issuer`, must not be `None`") # noqa: E501
+
+ self._issuer = issuer
+
+ @property
+ def issuance_date(self):
+ """Gets the issuance_date of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+
+
+ :return: The issuance_date of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :rtype: str
+ """
+ return self._issuance_date
+
+ @issuance_date.setter
+ def issuance_date(self, issuance_date):
+ """Sets the issuance_date of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate.
+
+
+ :param issuance_date: The issuance_date of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :type: str
+ """
+ if issuance_date is None:
+ raise ValueError("Invalid value for `issuance_date`, must not be `None`") # noqa: E501
+
+ self._issuance_date = issuance_date
+
+ @property
+ def credential_subject(self):
+ """Gets the credential_subject of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+
+
+ :return: The credential_subject of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :rtype: object
+ """
+ return self._credential_subject
+
+ @credential_subject.setter
+ def credential_subject(self, credential_subject):
+ """Sets the credential_subject of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate.
+
+
+ :param credential_subject: The credential_subject of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :type: object
+ """
+ if credential_subject is None:
+ raise ValueError("Invalid value for `credential_subject`, must not be `None`") # noqa: E501
+
+ self._credential_subject = credential_subject
+
+ @property
+ def display_html(self):
+ """Gets the display_html of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+
+
+ :return: The display_html of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :rtype: str
+ """
+ return self._display_html
+
+ @display_html.setter
+ def display_html(self, display_html):
+ """Sets the display_html of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate.
+
+
+ :param display_html: The display_html of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :type: str
+ """
+
+ self._display_html = display_html
+
+ @property
+ def crid(self):
+ """Gets the crid of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+
+
+ :return: The crid of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :rtype: str
+ """
+ return self._crid
+
+ @crid.setter
+ def crid(self, crid):
+ """Sets the crid of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate.
+
+
+ :param crid: The crid of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :type: str
+ """
+ if crid is None:
+ raise ValueError("Invalid value for `crid`, must not be `None`") # noqa: E501
+
+ self._crid = crid
+
+ @property
+ def crid_type(self):
+ """Gets the crid_type of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+
+
+ :return: The crid_type of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :rtype: str
+ """
+ return self._crid_type
+
+ @crid_type.setter
+ def crid_type(self, crid_type):
+ """Sets the crid_type of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate.
+
+
+ :param crid_type: The crid_type of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :type: str
+ """
+
+ self._crid_type = crid_type
+
+ @property
+ def metadata_json(self):
+ """Gets the metadata_json of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+
+
+ :return: The metadata_json of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :rtype: str
+ """
+ return self._metadata_json
+
+ @metadata_json.setter
+ def metadata_json(self, metadata_json):
+ """Sets the metadata_json of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate.
+
+
+ :param metadata_json: The metadata_json of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :type: str
+ """
+
+ self._metadata_json = metadata_json
+
+ @property
+ def proof(self):
+ """Gets the proof of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+
+
+ :return: The proof of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :rtype: object
+ """
+ return self._proof
+
+ @proof.setter
+ def proof(self, proof):
+ """Sets the proof of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate.
+
+
+ :param proof: The proof of this ControllerCertToolsGenerateUnsignedCertificateJsonCertificate. # noqa: E501
+ :type: object
+ """
+ if proof is None:
+ raise ValueError("Invalid value for `proof`, must not be `None`") # noqa: E501
+
+ self._proof = proof
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(ControllerCertToolsGenerateUnsignedCertificateJsonCertificate, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, ControllerCertToolsGenerateUnsignedCertificateJsonCertificate):
+ return False
+
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ return not self == other
diff --git a/src/caosadvancedtools/bloxberg/swagger_client/models/http_validation_error.py b/src/caosadvancedtools/bloxberg/swagger_client/models/http_validation_error.py
new file mode 100644
index 0000000000000000000000000000000000000000..21c9e467311c596499f3f408c5ac670b5852c6fa
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/swagger_client/models/http_validation_error.py
@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+ Research Object Certification
+
+ No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
+
+ OpenAPI spec version: 0.2.0
+
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+import pprint
+import re # noqa: F401
+
+import six
+
+class HTTPValidationError(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'detail': 'list[ValidationError]'
+ }
+
+ attribute_map = {
+ 'detail': 'detail'
+ }
+
+ def __init__(self, detail=None): # noqa: E501
+ """HTTPValidationError - a model defined in Swagger""" # noqa: E501
+ self._detail = None
+ self.discriminator = None
+ if detail is not None:
+ self.detail = detail
+
+ @property
+ def detail(self):
+ """Gets the detail of this HTTPValidationError. # noqa: E501
+
+
+ :return: The detail of this HTTPValidationError. # noqa: E501
+ :rtype: list[ValidationError]
+ """
+ return self._detail
+
+ @detail.setter
+ def detail(self, detail):
+ """Sets the detail of this HTTPValidationError.
+
+
+ :param detail: The detail of this HTTPValidationError. # noqa: E501
+ :type: list[ValidationError]
+ """
+
+ self._detail = detail
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(HTTPValidationError, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, HTTPValidationError):
+ return False
+
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ return not self == other
diff --git a/src/caosadvancedtools/bloxberg/swagger_client/models/validation_error.py b/src/caosadvancedtools/bloxberg/swagger_client/models/validation_error.py
new file mode 100644
index 0000000000000000000000000000000000000000..7ae6bf0900449ff3612798a4503692c4e38e1c11
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/swagger_client/models/validation_error.py
@@ -0,0 +1,165 @@
+# coding: utf-8
+
+"""
+ Research Object Certification
+
+ No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
+
+ OpenAPI spec version: 0.2.0
+
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+import pprint
+import re # noqa: F401
+
+import six
+
+class ValidationError(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'loc': 'list[str]',
+ 'msg': 'str',
+ 'type': 'str'
+ }
+
+ attribute_map = {
+ 'loc': 'loc',
+ 'msg': 'msg',
+ 'type': 'type'
+ }
+
+ def __init__(self, loc=None, msg=None, type=None): # noqa: E501
+ """ValidationError - a model defined in Swagger""" # noqa: E501
+ self._loc = None
+ self._msg = None
+ self._type = None
+ self.discriminator = None
+ self.loc = loc
+ self.msg = msg
+ self.type = type
+
+ @property
+ def loc(self):
+ """Gets the loc of this ValidationError. # noqa: E501
+
+
+ :return: The loc of this ValidationError. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._loc
+
+ @loc.setter
+ def loc(self, loc):
+ """Sets the loc of this ValidationError.
+
+
+ :param loc: The loc of this ValidationError. # noqa: E501
+ :type: list[str]
+ """
+ if loc is None:
+ raise ValueError("Invalid value for `loc`, must not be `None`") # noqa: E501
+
+ self._loc = loc
+
+ @property
+ def msg(self):
+ """Gets the msg of this ValidationError. # noqa: E501
+
+
+ :return: The msg of this ValidationError. # noqa: E501
+ :rtype: str
+ """
+ return self._msg
+
+ @msg.setter
+ def msg(self, msg):
+ """Sets the msg of this ValidationError.
+
+
+ :param msg: The msg of this ValidationError. # noqa: E501
+ :type: str
+ """
+ if msg is None:
+ raise ValueError("Invalid value for `msg`, must not be `None`") # noqa: E501
+
+ self._msg = msg
+
+ @property
+ def type(self):
+ """Gets the type of this ValidationError. # noqa: E501
+
+
+ :return: The type of this ValidationError. # noqa: E501
+ :rtype: str
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type):
+ """Sets the type of this ValidationError.
+
+
+ :param type: The type of this ValidationError. # noqa: E501
+ :type: str
+ """
+ if type is None:
+ raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501
+
+ self._type = type
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(ValidationError, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, ValidationError):
+ return False
+
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ return not self == other
diff --git a/src/caosadvancedtools/bloxberg/swagger_client/rest.py b/src/caosadvancedtools/bloxberg/swagger_client/rest.py
new file mode 100644
index 0000000000000000000000000000000000000000..c42e720c284832da70996e0eb885f6ffdcbb52d2
--- /dev/null
+++ b/src/caosadvancedtools/bloxberg/swagger_client/rest.py
@@ -0,0 +1,322 @@
+# coding: utf-8
+
+"""
+ Research Object Certification
+
+ No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
+
+ OpenAPI spec version: 0.2.0
+
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+import io
+import json
+import logging
+import re
+import ssl
+
+import certifi
+# python 2 and python 3 compatibility library
+import six
+from six.moves.urllib.parse import urlencode
+
+try:
+ import urllib3
+except ImportError:
+ raise ImportError('Swagger python client requires urllib3.')
+
+
+logger = logging.getLogger(__name__)
+
+
+class RESTResponse(io.IOBase):
+
+ def __init__(self, resp):
+ self.urllib3_response = resp
+ self.status = resp.status
+ self.reason = resp.reason
+ self.data = resp.data
+
+ def getheaders(self):
+ """Returns a dictionary of the response headers."""
+ return self.urllib3_response.getheaders()
+
+ def getheader(self, name, default=None):
+ """Returns a given response header."""
+ return self.urllib3_response.getheader(name, default)
+
+
+class RESTClientObject(object):
+
+ def __init__(self, configuration, pools_size=4, maxsize=None):
+ # urllib3.PoolManager will pass all kw parameters to connectionpool
+ # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501
+ # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501
+ # maxsize is the number of requests to host that are allowed in parallel # noqa: E501
+ # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501
+
+ # cert_reqs
+ if configuration.verify_ssl:
+ cert_reqs = ssl.CERT_REQUIRED
+ else:
+ cert_reqs = ssl.CERT_NONE
+
+ # ca_certs
+ if configuration.ssl_ca_cert:
+ ca_certs = configuration.ssl_ca_cert
+ else:
+ # if not set certificate file, use Mozilla's root certificates.
+ ca_certs = certifi.where()
+
+ addition_pool_args = {}
+ if configuration.assert_hostname is not None:
+ addition_pool_args['assert_hostname'] = configuration.assert_hostname # noqa: E501
+
+ if maxsize is None:
+ if configuration.connection_pool_maxsize is not None:
+ maxsize = configuration.connection_pool_maxsize
+ else:
+ maxsize = 4
+
+ # https pool manager
+ if configuration.proxy:
+ self.pool_manager = urllib3.ProxyManager(
+ num_pools=pools_size,
+ maxsize=maxsize,
+ cert_reqs=cert_reqs,
+ ca_certs=ca_certs,
+ cert_file=configuration.cert_file,
+ key_file=configuration.key_file,
+ proxy_url=configuration.proxy,
+ **addition_pool_args
+ )
+ else:
+ self.pool_manager = urllib3.PoolManager(
+ num_pools=pools_size,
+ maxsize=maxsize,
+ cert_reqs=cert_reqs,
+ ca_certs=ca_certs,
+ cert_file=configuration.cert_file,
+ key_file=configuration.key_file,
+ **addition_pool_args
+ )
+
+ def request(self, method, url, query_params=None, headers=None,
+ body=None, post_params=None, _preload_content=True,
+ _request_timeout=None):
+ """Perform requests.
+
+ :param method: http request method
+ :param url: http request url
+ :param query_params: query parameters in the url
+ :param headers: http request headers
+ :param body: request json body, for `application/json`
+ :param post_params: request post parameters,
+ `application/x-www-form-urlencoded`
+ and `multipart/form-data`
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ """
+ method = method.upper()
+ assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT',
+ 'PATCH', 'OPTIONS']
+
+ if post_params and body:
+ raise ValueError(
+ "body parameter cannot be used with post_params parameter."
+ )
+
+ post_params = post_params or {}
+ headers = headers or {}
+
+ timeout = None
+ if _request_timeout:
+ if isinstance(_request_timeout, (int, ) if six.PY3 else (int, long)): # noqa: E501,F821
+ timeout = urllib3.Timeout(total=_request_timeout)
+ elif (isinstance(_request_timeout, tuple) and
+ len(_request_timeout) == 2):
+ timeout = urllib3.Timeout(
+ connect=_request_timeout[0], read=_request_timeout[1])
+
+ if 'Content-Type' not in headers:
+ headers['Content-Type'] = 'application/json'
+
+ try:
+ # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+ if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+ if query_params:
+ url += '?' + urlencode(query_params)
+ if re.search('json', headers['Content-Type'], re.IGNORECASE):
+ request_body = '{}'
+ if body is not None:
+ request_body = json.dumps(body)
+ r = self.pool_manager.request(
+ method, url,
+ body=request_body,
+ preload_content=_preload_content,
+ timeout=timeout,
+ headers=headers)
+ elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501
+ r = self.pool_manager.request(
+ method, url,
+ fields=post_params,
+ encode_multipart=False,
+ preload_content=_preload_content,
+ timeout=timeout,
+ headers=headers)
+ elif headers['Content-Type'] == 'multipart/form-data':
+ # must del headers['Content-Type'], or the correct
+ # Content-Type which generated by urllib3 will be
+ # overwritten.
+ del headers['Content-Type']
+ r = self.pool_manager.request(
+ method, url,
+ fields=post_params,
+ encode_multipart=True,
+ preload_content=_preload_content,
+ timeout=timeout,
+ headers=headers)
+ # Pass a `string` parameter directly in the body to support
+ # other content types than Json when `body` argument is
+ # provided in serialized form
+ elif isinstance(body, str):
+ request_body = body
+ r = self.pool_manager.request(
+ method, url,
+ body=request_body,
+ preload_content=_preload_content,
+ timeout=timeout,
+ headers=headers)
+ else:
+ # Cannot generate the request from given parameters
+ msg = """Cannot prepare a request message for provided
+ arguments. Please check that your arguments match
+ declared content type."""
+ raise ApiException(status=0, reason=msg)
+ # For `GET`, `HEAD`
+ else:
+ r = self.pool_manager.request(method, url,
+ fields=query_params,
+ preload_content=_preload_content,
+ timeout=timeout,
+ headers=headers)
+ except urllib3.exceptions.SSLError as e:
+ msg = "{0}\n{1}".format(type(e).__name__, str(e))
+ raise ApiException(status=0, reason=msg)
+
+ if _preload_content:
+ r = RESTResponse(r)
+
+ # In the python 3, the response.data is bytes.
+ # we need to decode it to string.
+ if six.PY3:
+ r.data = r.data.decode('utf8')
+
+ # log response body
+ logger.debug("response body: %s", r.data)
+
+ if not 200 <= r.status <= 299:
+ raise ApiException(http_resp=r)
+
+ return r
+
+ def GET(self, url, headers=None, query_params=None, _preload_content=True,
+ _request_timeout=None):
+ return self.request("GET", url,
+ headers=headers,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout,
+ query_params=query_params)
+
+ def HEAD(self, url, headers=None, query_params=None, _preload_content=True,
+ _request_timeout=None):
+ return self.request("HEAD", url,
+ headers=headers,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout,
+ query_params=query_params)
+
+ def OPTIONS(self, url, headers=None, query_params=None, post_params=None,
+ body=None, _preload_content=True, _request_timeout=None):
+ return self.request("OPTIONS", url,
+ headers=headers,
+ query_params=query_params,
+ post_params=post_params,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout,
+ body=body)
+
+ def DELETE(self, url, headers=None, query_params=None, body=None,
+ _preload_content=True, _request_timeout=None):
+ return self.request("DELETE", url,
+ headers=headers,
+ query_params=query_params,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout,
+ body=body)
+
+ def POST(self, url, headers=None, query_params=None, post_params=None,
+ body=None, _preload_content=True, _request_timeout=None):
+ return self.request("POST", url,
+ headers=headers,
+ query_params=query_params,
+ post_params=post_params,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout,
+ body=body)
+
+ def PUT(self, url, headers=None, query_params=None, post_params=None,
+ body=None, _preload_content=True, _request_timeout=None):
+ return self.request("PUT", url,
+ headers=headers,
+ query_params=query_params,
+ post_params=post_params,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout,
+ body=body)
+
+ def PATCH(self, url, headers=None, query_params=None, post_params=None,
+ body=None, _preload_content=True, _request_timeout=None):
+ return self.request("PATCH", url,
+ headers=headers,
+ query_params=query_params,
+ post_params=post_params,
+ _preload_content=_preload_content,
+ _request_timeout=_request_timeout,
+ body=body)
+
+
+class ApiException(Exception):
+
+ def __init__(self, status=None, reason=None, http_resp=None):
+ if http_resp:
+ self.status = http_resp.status
+ self.reason = http_resp.reason
+ self.body = http_resp.data
+ self.headers = http_resp.getheaders()
+ else:
+ self.status = status
+ self.reason = reason
+ self.body = None
+ self.headers = None
+
+ def __str__(self):
+ """Custom error messages for exception"""
+ error_message = "({0})\n"\
+ "Reason: {1}\n".format(self.status, self.reason)
+ if self.headers:
+ error_message += "HTTP response headers: {0}\n".format(
+ self.headers)
+
+ if self.body:
+ error_message += "HTTP response body: {0}\n".format(self.body)
+
+ return error_message
diff --git a/src/caosadvancedtools/cache.py b/src/caosadvancedtools/cache.py
index c255a00d0216c2b944e54158de6910538f3da1ae..3dac86ec328944303c629c8de721fb1a2f6a7bef 100644
--- a/src/caosadvancedtools/cache.py
+++ b/src/caosadvancedtools/cache.py
@@ -171,13 +171,16 @@ class UpdateCache(Cache):
return old_ones
def insert(self, cont, run_id):
- """ insert a pending, unauthorized update
+ """Insert a pending, unauthorized update
- Parameters:
- -----------
+
+ Parameters
+ ----------
cont: Container with the records to be updated containing the desired
version, i.e. the state after the update.
- run_id: the id of the crawler run
+
+ run_id: int
+ The id of the crawler run
"""
cont = put_in_container(cont)
old_ones = UpdateCache.get_previous_version(cont)
diff --git a/src/caosadvancedtools/crawler.py b/src/caosadvancedtools/crawler.py
index a01b13ca5b5ef61163e77063e68a3ca938bfbf84..c26c681e8e0231c63ac105af0642a387b2e3e0c5 100644
--- a/src/caosadvancedtools/crawler.py
+++ b/src/caosadvancedtools/crawler.py
@@ -629,6 +629,10 @@ carefully and if the changes are ok, click on the following link:
raise ValueError("The identifiable must have at least one parent.")
query_string = "FIND Record " + ident.get_parents()[0].name
query_string += " WITH "
+ if ident.name is None and len(ident.get_properties()) == 0:
+ raise ValueError(
+ "The identifiable must have features to identify it.")
+
if ident.name is not None:
query_string += "name='{}' AND".format(ident.name)
diff --git a/src/caosadvancedtools/export_related.py b/src/caosadvancedtools/export_related.py
index 47fe2f4900add818e940fa81466bb9c98a2f0223..00f440d28a2ae1da14132083e4b8d3c5003d1b65 100755
--- a/src/caosadvancedtools/export_related.py
+++ b/src/caosadvancedtools/export_related.py
@@ -47,6 +47,9 @@ def get_ids_of_related_entities(entity):
"""
entities = []
+ if isinstance(entity, int):
+ entity = db.Entity(id=entity).retrieve()
+
for par in entity.parents:
entities.append(par.id)
@@ -76,20 +79,17 @@ def recursively_collect_related(entity):
"""
all_entities = db.Container()
all_entities.append(entity)
- ids = set([entity.id])
- new_entities = [entity]
+ ids = set()
+ new_ids = set([entity.id])
- while new_entities:
- new_ids = set()
+ while new_ids:
+ ids.update(new_ids)
- for ent in new_entities:
- new_ids.update(get_ids_of_related_entities(ent))
+ for eid in list(new_ids):
+ new_ids.update(get_ids_of_related_entities(eid))
new_ids = new_ids - ids
- new_entities = retrieve_entities_with_ids(list(new_ids))
- ids.update([e.id for e in new_entities])
- all_entities.extend(new_entities)
- return all_entities
+ return retrieve_entities_with_ids(list(ids))
def invert_ids(entities):
diff --git a/src/caosadvancedtools/import_from_xml.py b/src/caosadvancedtools/import_from_xml.py
index 0bf9b1c0cbb478bb75687f9f3e41ca2d4960d2c0..9d0e03f649db771147915740cabf201fae910760 100755
--- a/src/caosadvancedtools/import_from_xml.py
+++ b/src/caosadvancedtools/import_from_xml.py
@@ -57,7 +57,7 @@ def import_xml(filename, rerun=False, interactive=True):
tmpfile = create_dummy_file()
model = []
- files = []
+ files = {}
# add files to files list and properties and record types to model
@@ -70,19 +70,19 @@ def import_xml(filename, rerun=False, interactive=True):
el.file = target
else:
el.file = tmpfile
- files.append(el)
+ files[el.path] = el
if (isinstance(el, db.Property) or isinstance(el, db.RecordType)):
model.append(el)
# remove entities of the model from the container
- for el in model+files:
+ for el in model+list(files.values()):
cont.remove(el)
id_mapping = {}
- for el in model+files:
+ for el in model+list(files.values()):
id_mapping[el.id] = el
# insert/update the model
@@ -93,10 +93,10 @@ def import_xml(filename, rerun=False, interactive=True):
# insert files
if not rerun:
- for _, el in enumerate(files):
+ for _, el in enumerate(files.values()):
r = el.insert(unique=False)
else:
- for _, el in enumerate(files):
+ for _, el in enumerate(files.values()):
el.id = None
el.retrieve()
diff --git a/src/caosadvancedtools/models/__init__.py b/src/caosadvancedtools/models/__init__.py
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..d70cb810488ba846e5311cbb50991c3eb32bdfad 100644
--- a/src/caosadvancedtools/models/__init__.py
+++ b/src/caosadvancedtools/models/__init__.py
@@ -0,0 +1,2 @@
+"""Submodule for working with data models.
+"""
diff --git a/src/caosadvancedtools/models/data_model.py b/src/caosadvancedtools/models/data_model.py
index f4fd7c7e311d6e0d798bac5054b5614f8525ae83..a4804dd0fb0300af9b166717f41f341a57b677d4 100644
--- a/src/caosadvancedtools/models/data_model.py
+++ b/src/caosadvancedtools/models/data_model.py
@@ -106,7 +106,7 @@ class DataModel(dict):
print(ent.name)
if noquestion or str(input("Do you really want to insert those "
- "entities? [y] ")).lower() == "y":
+ "entities? [y/N] ")).lower() == "y":
non_existing_entities.insert()
self.sync_ids_by_name(non_existing_entities)
print("Updated entities.")
@@ -131,7 +131,7 @@ class DataModel(dict):
if any_change:
if noquestion or input("Do you really want to apply the above "
- "changes? [y]") == "y":
+ "changes? [y/N]") == "y":
existing_entities.update()
print("Synchronized existing entities.")
else:
@@ -171,9 +171,7 @@ class DataModel(dict):
A iterable with entities.
names : iterable of str
Only entities which do *not* have one of these names will end up in
- the
-
- returned iterable.
+ the returned iterable.
Returns
-------
diff --git a/src/caosadvancedtools/models/parser.py b/src/caosadvancedtools/models/parser.py
index d2fbf506a6f1435481ab25de29e664722f71c46a..5e1532e03690e753b8926b87b01db4e3a89f2c4c 100644
--- a/src/caosadvancedtools/models/parser.py
+++ b/src/caosadvancedtools/models/parser.py
@@ -1,5 +1,5 @@
"""
-This script provides the a function to read a DataModel from a yaml file.
+This module (and script) provides methods to read a DataModel from a YAML file.
If a file name is passed to parse_model_from_yaml it is parsed and a DataModel
is created. The yaml file needs to be structured in a certain way which will be
@@ -13,7 +13,7 @@ and will be added with the respective importance. These properties can be
RecordTypes or Properties and can be defined right there.
Every Property or RecordType only needs to be defined once anywhere. When it is
not defined, simply the name can be supplied with no value.
-Parents can be provided under the inherit_from_xxxx keywords. The value needs
+Parents can be provided under the 'inherit_from_xxxx' keywords. The value needs
to be a list with the names. Here, NO NEW entities can be defined.
"""
import re
@@ -24,9 +24,10 @@ import yaml
from .data_model import DataModel
+# Keywords which are allowed in data model descriptions.
KEYWORDS = ["parent",
"importance",
- "datatype",
+ "datatype", # for example TEXT, INTEGER or REFERENCE
"unit",
"description",
"recommended_properties",
@@ -95,12 +96,12 @@ class Parser(object):
Parameters
----------
filename : str
- The path to the YAML file.
+ The path to the YAML file.
Returns
-------
out : DataModel
- The created DataModel
+ The created DataModel
"""
with open(filename, 'r') as outfile:
ymlmodel = yaml.load(outfile, Loader=SafeLineLoader)
@@ -112,12 +113,12 @@ class Parser(object):
Parameters
----------
string : str
- The YAML string.
+ The YAML string.
Returns
-------
out : DataModel
- The created DataModel
+ The created DataModel
"""
ymlmodel = yaml.load(string, Loader=SafeLineLoader)
return self._create_model_from_dict(ymlmodel)
@@ -128,12 +129,12 @@ class Parser(object):
Parameters
----------
ymlmodel : dict
- The dictionary parsed from a YAML file.
+ The dictionary parsed from a YAML file.
Returns
-------
out : DataModel
- The created DataModel
+ The created DataModel
"""
if not isinstance(ymlmodel, dict):
@@ -185,15 +186,15 @@ class Parser(object):
Parameters
----------
name :
- The value to be converted to a string.
+ The value to be converted to a string.
context : obj
- Will be printed in the case of warnings.
+ Will be printed in the case of warnings.
Returns
-------
out : str
- If `name` was a string, return it. Else return str(`name`).
+ If `name` was a string, return it. Else return str(`name`).
"""
if name is None:
print("WARNING: Name of this context is None: {}".format(context),
diff --git a/src/caosadvancedtools/models/version.py b/src/caosadvancedtools/models/version.py
deleted file mode 100644
index 29c67c6877a6531adc0fe337d497e26d15825006..0000000000000000000000000000000000000000
--- a/src/caosadvancedtools/models/version.py
+++ /dev/null
@@ -1,32 +0,0 @@
-#
-# ** header v3.0
-# This file is a part of the CaosDB Project.
-#
-# Copyright (C) 2018 Research Group Biomedical Physics,
-# Max-Planck-Institute for Dynamics and Self-Organization Göttingen
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as
-# published by the Free Software Foundation, either version 3 of the
-# License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program. If not, see <https://www.gnu.org/licenses/>.
-#
-# ** end header
-#
-
-# THIS FILE IS GENERATED FROM SETUP.PY
-short_version = '0.1.0'
-version = '0.1.0'
-full_version = '0.1.0.dev-Unknown'
-git_revision = 'Unknown'
-release = False
-
-if not release:
- version = full_version
diff --git a/src/doc/Makefile b/src/doc/Makefile
index d28503eb0e883e6c879898c12dac07f91bd2df68..7a1bec105f4b0fe1d70cabd7e3cf5f1ceff93bee 100644
--- a/src/doc/Makefile
+++ b/src/doc/Makefile
@@ -45,4 +45,4 @@ doc-help:
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
apidoc:
- @$(SPHINXAPIDOC) -o _apidoc $(PY_BASEDIR)
+ @$(SPHINXAPIDOC) --force -o _apidoc $(PY_BASEDIR)
diff --git a/src/doc/conf.py b/src/doc/conf.py
index 29b790d4d445f2f9c155a0858b00a1a289e0ec4e..fef2ee6760d71cdbe544c4c0c8dbabe34eb79475 100644
--- a/src/doc/conf.py
+++ b/src/doc/conf.py
@@ -17,12 +17,13 @@
# sys.path.insert(0, os.path.abspath('../caosdb'))
-# -- Project information -----------------------------------------------------
-
import sphinx_rtd_theme
+
+# -- Project information -----------------------------------------------------
+
project = 'caosadvancedtools'
-copyright = '2020, IndiScale GmbH'
+copyright = '2021, IndiScale GmbH'
author = 'Daniel Hornung'
# The short X.Y version
@@ -92,6 +93,9 @@ html_theme = "sphinx_rtd_theme"
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
+# Disable static path to remove warning.
+html_static_path = []
+
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
@@ -185,10 +189,11 @@ epub_exclude_files = ['search.html']
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
- 'https://docs.python.org/': None,
+ "python": ("https://docs.python.org/", None),
"caosdb-pylib": ("https://caosdb.gitlab.io/caosdb-pylib/", None),
}
+
# TODO Which options do we want?
autodoc_default_options = {
'members': None,
diff --git a/src/doc/crawler.rst b/src/doc/crawler.rst
index 92a624bb59f4c0fba8d46076d6df0e0e30bbab75..7c95dad9ed10c025bc1baf811feb4534fc994175 100644
--- a/src/doc/crawler.rst
+++ b/src/doc/crawler.rst
@@ -3,7 +3,7 @@ CaosDB Crawler
==============
The `CaosDB
-crawler <https://gitlab.com/caosdb/caosdb-advanced-user-tools/blob/master/src/caosadvancedtools/crawler.py>`__
+crawler <https://gitlab.com/caosdb/caosdb-advanced-user-tools/blob/main/src/caosadvancedtools/crawler.py>`__
is a tool for the automated insertion or update of entities in CaosDB.
Typically, a file structure is crawled, but other things can be crawled as well.
For example tables or HDF5 files.
@@ -75,7 +75,7 @@ The crawler can be executed directly via a python script (usually called
``crawl.py``). The script prints the progress and reports potential
problems. The exact behavior depends on your setup. However, you can
have a look at the example in the
-`tests <https://gitlab.com/caosdb/caosdb-advanced-user-tools/-/blob/master/integrationtests/full_test/crawl.py>`__.
+`tests <https://gitlab.com/caosdb/caosdb-advanced-user-tools/-/blob/main/integrationtests/full_test/crawl.py>`__.
.. Note:: The crawler depends on the CaosDB Python client, so make sure to install :doc:`pycaosdb
<caosdb-pylib:getting_started>`.
diff --git a/unittests/test_crawler.py b/unittests/test_crawler.py
index f603031eddbcf1e10c2842ec4e89ca591700b94f..64bf291c1181d901ac39a4d2535dcd6eddf39f70 100644
--- a/unittests/test_crawler.py
+++ b/unittests/test_crawler.py
@@ -45,3 +45,7 @@ class CrawlerTest(unittest.TestCase):
datatype=db.LIST("RT2"))
qs = Crawler.create_query_for_identifiable(ident)
assert qs == "FIND Record RT WITH references 2345 AND references 234567 "
+ ident = db.Record()
+ ident.add_parent(name="RT")
+ self.assertRaises(ValueError, Crawler.create_query_for_identifiable,
+ ident)