qciconnect-client 1.0.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- qciconnect_client-1.0.2/LICENSE +22 -0
- qciconnect_client-1.0.2/PKG-INFO +34 -0
- qciconnect_client-1.0.2/README.md +13 -0
- qciconnect_client-1.0.2/pyproject.toml +155 -0
- qciconnect_client-1.0.2/src/qciconnect/client/__init__.py +4 -0
- qciconnect_client-1.0.2/src/qciconnect/client/client.py +544 -0
- qciconnect_client-1.0.2/src/qciconnect/client/exceptions.py +12 -0
- qciconnect_client-1.0.2/src/qciconnect/client/mageia.py +123 -0
- qciconnect_client-1.0.2/src/qciconnect/client/methods.py +138 -0
- qciconnect_client-1.0.2/src/qciconnect/client/qpus.py +433 -0
- qciconnect_client-1.0.2/src/qciconnect/client/result_handling.py +290 -0
- qciconnect_client-1.0.2/src/qciconnect/client/token_managers.py +25 -0
- qciconnect_client-1.0.2/src/qciconnect/client/utils.py +23 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 German Aerospace Center / Deutsches Zentrum für Luft- und Raumfahrt (DLR)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
7
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
8
|
+
in the Software without restriction, including without limitation the rights
|
|
9
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
10
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
11
|
+
furnished to do so, subject to the following conditions:
|
|
12
|
+
|
|
13
|
+
The above copyright notice and this permission notice shall be included in all
|
|
14
|
+
copies or substantial portions of the Software.
|
|
15
|
+
|
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
17
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
18
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
19
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
20
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
21
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
22
|
+
SOFTWARE.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: qciconnect-client
|
|
3
|
+
Version: 1.0.2
|
|
4
|
+
Summary: An API client to work with the DLR QCI Connect quantum computing platform.
|
|
5
|
+
Keywords: quantum computing,API client,QCI Connect
|
|
6
|
+
Author: DLR-SC, David da Costa, Thomas Keitzl, Elisabeth Lobe, Johannes Renkl, Gary Schmiedinghoff, Thomas Stehle, Lukas Windgätter
|
|
7
|
+
Author-email: DLR-SC <qc-software@dlr.de>
|
|
8
|
+
License-Expression: MIT
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
11
|
+
Classifier: Programming Language :: Python
|
|
12
|
+
Classifier: Operating System :: OS Independent
|
|
13
|
+
Requires-Dist: qciconnect-common
|
|
14
|
+
Requires-Dist: httpx>=0.28.1,<0.29
|
|
15
|
+
Requires-Dist: pydantic>=2.10.6,<3
|
|
16
|
+
Requires-Dist: tabulate>=0.9.0,<0.10
|
|
17
|
+
Requires-Dist: numpy>=2.0.0,<3
|
|
18
|
+
Requires-Dist: typeguard>=4.4.4
|
|
19
|
+
Requires-Python: >=3.12
|
|
20
|
+
Description-Content-Type: text/markdown
|
|
21
|
+
|
|
22
|
+
[](https://api-client-d69c16.pages.gitlab.dlr.de/)
|
|
23
|
+
|
|
24
|
+
# QCI Connect API Client
|
|
25
|
+
|
|
26
|
+
This is a python package to interact with the [QCI Connect](https://connect.qci.dlr.de/) platform of the [German Aerospace Center (DLR)](https://www.dlr.de/).
|
|
27
|
+
It also allows local testing, deployment, and interaction with the platform's compiler stack.
|
|
28
|
+
|
|
29
|
+
## Quick Start
|
|
30
|
+
|
|
31
|
+
The following steps provide a quick start on how to programmatically interact with the QCI Connect platform:
|
|
32
|
+
|
|
33
|
+
- Run `pip install qciconnect-client`
|
|
34
|
+
- Run `jupyter notebook` and navigate to _./docs/examples/example_remote.ipynb_
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[](https://api-client-d69c16.pages.gitlab.dlr.de/)
|
|
2
|
+
|
|
3
|
+
# QCI Connect API Client
|
|
4
|
+
|
|
5
|
+
This is a python package to interact with the [QCI Connect](https://connect.qci.dlr.de/) platform of the [German Aerospace Center (DLR)](https://www.dlr.de/).
|
|
6
|
+
It also allows local testing, deployment, and interaction with the platform's compiler stack.
|
|
7
|
+
|
|
8
|
+
## Quick Start
|
|
9
|
+
|
|
10
|
+
The following steps provide a quick start on how to programmatically interact with the QCI Connect platform:
|
|
11
|
+
|
|
12
|
+
- Run `pip install qciconnect-client`
|
|
13
|
+
- Run `jupyter notebook` and navigate to _./docs/examples/example_remote.ipynb_
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "qciconnect-client"
|
|
3
|
+
version = "1.0.2"
|
|
4
|
+
description = "An API client to work with the DLR QCI Connect quantum computing platform."
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
authors = [
|
|
7
|
+
{ name = "DLR-SC", email = "qc-software@dlr.de" },
|
|
8
|
+
{ name = "David da Costa" },
|
|
9
|
+
{ name = "Thomas Keitzl" },
|
|
10
|
+
{ name = "Elisabeth Lobe" },
|
|
11
|
+
{ name = "Johannes Renkl" },
|
|
12
|
+
{ name = "Gary Schmiedinghoff" },
|
|
13
|
+
{ name = "Thomas Stehle" },
|
|
14
|
+
{ name = "Lukas Windgätter" },
|
|
15
|
+
]
|
|
16
|
+
requires-python = ">=3.12"
|
|
17
|
+
license = "MIT"
|
|
18
|
+
keywords = [
|
|
19
|
+
"quantum computing",
|
|
20
|
+
"API client",
|
|
21
|
+
"QCI Connect",
|
|
22
|
+
]
|
|
23
|
+
classifiers = [
|
|
24
|
+
"Programming Language :: Python :: 3",
|
|
25
|
+
"Programming Language :: Python",
|
|
26
|
+
"Operating System :: OS Independent",
|
|
27
|
+
]
|
|
28
|
+
|
|
29
|
+
dependencies = [
|
|
30
|
+
"qciconnect-common",
|
|
31
|
+
"httpx>=0.28.1,<0.29",
|
|
32
|
+
"pydantic>=2.10.6,<3",
|
|
33
|
+
"tabulate>=0.9.0,<0.10",
|
|
34
|
+
"numpy>=2.0.0,<3",
|
|
35
|
+
"typeguard>=4.4.4",
|
|
36
|
+
]
|
|
37
|
+
|
|
38
|
+
license-files = ["LICEN[CS]E*"]
|
|
39
|
+
|
|
40
|
+
[tool.uv]
|
|
41
|
+
package = true
|
|
42
|
+
|
|
43
|
+
[tool.uv.build-backend]
|
|
44
|
+
module-name = "qciconnect.client"
|
|
45
|
+
module-root = "src"
|
|
46
|
+
|
|
47
|
+
[build-system]
|
|
48
|
+
requires = ["uv_build>=0.10.9,<0.11.0"]
|
|
49
|
+
build-backend = "uv_build"
|
|
50
|
+
|
|
51
|
+
[dependency-groups]
|
|
52
|
+
dev = [
|
|
53
|
+
"httpx>=0.28.1,<0.29",
|
|
54
|
+
"pydantic>=2.10.6,<3",
|
|
55
|
+
"tabulate>=0.9.0,<0.10",
|
|
56
|
+
"numpy>=2.0.0,<3",
|
|
57
|
+
"typeguard>=4.4.4",
|
|
58
|
+
"ipython>=9.1.0",
|
|
59
|
+
"jupyter>=1.1.1",
|
|
60
|
+
"mypy>=1.11.2",
|
|
61
|
+
"notebook>=7.4.7",
|
|
62
|
+
"pre-commit>=4.2.0",
|
|
63
|
+
"pytest>=8.3.5",
|
|
64
|
+
"pytest-cov>=6.1.1",
|
|
65
|
+
"qiskit>=2.2.1",
|
|
66
|
+
"qiskit-qasm3-import==0.5.0",
|
|
67
|
+
"ruff>=0.12.4",
|
|
68
|
+
"uvicorn>=0.38.0",
|
|
69
|
+
"sphinx>=8.2.3",
|
|
70
|
+
"nbsphinx>=0.9.6",
|
|
71
|
+
"sphinx-autodoc2>=0.0.0",
|
|
72
|
+
"myst-parser>=0.14.0",
|
|
73
|
+
"qciconnect-common",
|
|
74
|
+
"sphinx-rtd-theme>=3.1.0",
|
|
75
|
+
]
|
|
76
|
+
test = [
|
|
77
|
+
"ipython>=9.1.0",
|
|
78
|
+
"jupyter>=1.1.1",
|
|
79
|
+
"pytest>=8.3.5",
|
|
80
|
+
"pytest-cov>=6.1.1",
|
|
81
|
+
"qiskit>=2.0.0,<3",
|
|
82
|
+
"qiskit-qasm3-import==0.5.0",
|
|
83
|
+
"ruff>=0.12.4",
|
|
84
|
+
]
|
|
85
|
+
test-nb = [
|
|
86
|
+
"ipython>=9.1.0",
|
|
87
|
+
"jupyter>=1.1.1",
|
|
88
|
+
"qiskit>=2.0.0,<3",
|
|
89
|
+
"qiskit-qasm3-import==0.5.0"
|
|
90
|
+
]
|
|
91
|
+
|
|
92
|
+
[tool.ruff]
|
|
93
|
+
line-length = 100
|
|
94
|
+
target-version = "py312"
|
|
95
|
+
include = [
|
|
96
|
+
"pyproject.toml",
|
|
97
|
+
"src/**/*.py",
|
|
98
|
+
]
|
|
99
|
+
|
|
100
|
+
[tool.ruff.lint]
|
|
101
|
+
select = [
|
|
102
|
+
"A", # flake8-buitins
|
|
103
|
+
"B", # flake8-bugbear
|
|
104
|
+
"BLE", # flake8-blind-except
|
|
105
|
+
"C4", # flak8-comprehensions
|
|
106
|
+
"PT", # flake8-pytest-style
|
|
107
|
+
"PTH", # flake8-use-pathlib
|
|
108
|
+
"RSE", # flake8-raise
|
|
109
|
+
"SIM", # flake8-simplify
|
|
110
|
+
"TCH", # flake8-type-checking
|
|
111
|
+
"FA", # flake8-future-annotations
|
|
112
|
+
"ICN", # flake8-import-conventions
|
|
113
|
+
"N", # pep8-naming
|
|
114
|
+
"I", # isort
|
|
115
|
+
"F", # pyflakes
|
|
116
|
+
"ERA", # eradicate
|
|
117
|
+
# "D", # pydocstyle
|
|
118
|
+
"E", # pycodestyle Error
|
|
119
|
+
"NPY", # numpy specific rules
|
|
120
|
+
"RUF", # Ruff-specific rules
|
|
121
|
+
"UP", # pyupgrade
|
|
122
|
+
"TID", # tidy imports
|
|
123
|
+
"TRY", # exception handling
|
|
124
|
+
"DTZ", # timezone-aware datetimes
|
|
125
|
+
"ARG", # unused arguments
|
|
126
|
+
]
|
|
127
|
+
ignore = [
|
|
128
|
+
"TRY003", # Avoid specifying long messages outside the exception class
|
|
129
|
+
]
|
|
130
|
+
|
|
131
|
+
[tool.ruff.lint.isort]
|
|
132
|
+
force-sort-within-sections = false
|
|
133
|
+
|
|
134
|
+
[tool.ruff.lint.pycodestyle]
|
|
135
|
+
max-doc-length = 120
|
|
136
|
+
|
|
137
|
+
[tool.ruff.lint.pydocstyle]
|
|
138
|
+
convention = "google"
|
|
139
|
+
|
|
140
|
+
[tool.ruff.lint.per-file-ignores]
|
|
141
|
+
"*/__init__.py" = ["F401", "F403", "D104"]
|
|
142
|
+
"tests/*" = ["D"]
|
|
143
|
+
|
|
144
|
+
[tool.pytest.ini_options]
|
|
145
|
+
addopts = "-rP --cov=src --cov-report=term-missing -o junit_logging=all -o junit_log_passing_tests=True --junitxml=reports/junit_coverage.xml"
|
|
146
|
+
testpaths = [
|
|
147
|
+
"tests/",
|
|
148
|
+
]
|
|
149
|
+
typeguard-packages = "qciconnect-client"
|
|
150
|
+
typeguard-debug-instrumentation = true
|
|
151
|
+
typeguard-forward-ref-policy = "ERROR"
|
|
152
|
+
pythonpath = [
|
|
153
|
+
"src/",
|
|
154
|
+
"submodules/qciconnect/common/src",
|
|
155
|
+
]
|