qcloud-client 0.0.1__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.
- qcloud_client-0.0.1/.github/CODEOWNERS +1 -0
- qcloud_client-0.0.1/.github/dependabot.yaml +11 -0
- qcloud_client-0.0.1/.github/workflows/lint.yml +32 -0
- qcloud_client-0.0.1/.github/workflows/release.yml +54 -0
- qcloud_client-0.0.1/.gitignore +221 -0
- qcloud_client-0.0.1/.ruff.toml +37 -0
- qcloud_client-0.0.1/LICENSE +21 -0
- qcloud_client-0.0.1/PKG-INFO +84 -0
- qcloud_client-0.0.1/README.md +61 -0
- qcloud_client-0.0.1/SECURITY.md +35 -0
- qcloud_client-0.0.1/pyproject.toml +46 -0
- qcloud_client-0.0.1/requirements.txt +8 -0
- qcloud_client-0.0.1/setup.cfg +4 -0
- qcloud_client-0.0.1/src/qcloud_client/__init__.py +1 -0
- qcloud_client-0.0.1/src/qcloud_client/_version.py +24 -0
- qcloud_client-0.0.1/src/qcloud_client/client.py +0 -0
- qcloud_client-0.0.1/src/qcloud_client/core.py +0 -0
- qcloud_client-0.0.1/src/qcloud_client.egg-info/PKG-INFO +84 -0
- qcloud_client-0.0.1/src/qcloud_client.egg-info/SOURCES.txt +23 -0
- qcloud_client-0.0.1/src/qcloud_client.egg-info/dependency_links.txt +1 -0
- qcloud_client-0.0.1/src/qcloud_client.egg-info/requires.txt +6 -0
- qcloud_client-0.0.1/src/qcloud_client.egg-info/scm_file_list.json +19 -0
- qcloud_client-0.0.1/src/qcloud_client.egg-info/scm_version.json +8 -0
- qcloud_client-0.0.1/src/qcloud_client.egg-info/top_level.txt +1 -0
- qcloud_client-0.0.1/tests/.gitkeep +0 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
* @gegelendvay @neago
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
name: Lint
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
push:
|
|
6
|
+
branches: [main]
|
|
7
|
+
|
|
8
|
+
concurrency:
|
|
9
|
+
group: lint-${{ github.ref }}
|
|
10
|
+
cancel-in-progress: true
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
lint:
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
steps:
|
|
16
|
+
- name: Checkout repository
|
|
17
|
+
uses: actions/checkout@v7
|
|
18
|
+
- name: Set up Python
|
|
19
|
+
uses: actions/setup-python@v7
|
|
20
|
+
with:
|
|
21
|
+
python-version: "3.12"
|
|
22
|
+
cache: "pip"
|
|
23
|
+
- name: Install dependencies
|
|
24
|
+
run: |
|
|
25
|
+
python -m venv .venv
|
|
26
|
+
source .venv/bin/activate
|
|
27
|
+
pip install --upgrade pip
|
|
28
|
+
pip install -r requirements.txt
|
|
29
|
+
- name: Run Ruff
|
|
30
|
+
run: |
|
|
31
|
+
source .venv/bin/activate
|
|
32
|
+
ruff check . --output-format=github
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
name: Release
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags: ["v*"]
|
|
6
|
+
|
|
7
|
+
permissions: {}
|
|
8
|
+
|
|
9
|
+
concurrency:
|
|
10
|
+
group: release
|
|
11
|
+
cancel-in-progress: false
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
build:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
permissions:
|
|
17
|
+
contents: read
|
|
18
|
+
steps:
|
|
19
|
+
- name: Checkout repository
|
|
20
|
+
uses: actions/checkout@v7
|
|
21
|
+
with:
|
|
22
|
+
fetch-depth: 0
|
|
23
|
+
- name: Set up Python
|
|
24
|
+
uses: actions/setup-python@v7
|
|
25
|
+
with:
|
|
26
|
+
python-version: "3.12"
|
|
27
|
+
- name: Build sdist and wheel
|
|
28
|
+
run: |
|
|
29
|
+
python -m pip install --upgrade pip build twine
|
|
30
|
+
python -m build
|
|
31
|
+
- name: Check metadata
|
|
32
|
+
run: python -m twine check dist/*
|
|
33
|
+
- name: Upload distributions
|
|
34
|
+
uses: actions/upload-artifact@v4
|
|
35
|
+
with:
|
|
36
|
+
name: dist
|
|
37
|
+
path: dist/
|
|
38
|
+
|
|
39
|
+
publish:
|
|
40
|
+
needs: build
|
|
41
|
+
runs-on: ubuntu-latest
|
|
42
|
+
environment:
|
|
43
|
+
name: pypi
|
|
44
|
+
url: https://pypi.org/project/qcloud-client/
|
|
45
|
+
permissions:
|
|
46
|
+
id-token: write
|
|
47
|
+
steps:
|
|
48
|
+
- name: Download distributions
|
|
49
|
+
uses: actions/download-artifact@v4
|
|
50
|
+
with:
|
|
51
|
+
name: dist
|
|
52
|
+
path: dist/
|
|
53
|
+
- name: Publish
|
|
54
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[codz]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py.cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
# Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# UV
|
|
98
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
99
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
+
# commonly ignored for libraries.
|
|
101
|
+
# uv.lock
|
|
102
|
+
|
|
103
|
+
# poetry
|
|
104
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
105
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
106
|
+
# commonly ignored for libraries.
|
|
107
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
108
|
+
# poetry.lock
|
|
109
|
+
# poetry.toml
|
|
110
|
+
|
|
111
|
+
# pdm
|
|
112
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
113
|
+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
|
114
|
+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
|
115
|
+
# pdm.lock
|
|
116
|
+
# pdm.toml
|
|
117
|
+
.pdm-python
|
|
118
|
+
.pdm-build/
|
|
119
|
+
|
|
120
|
+
# pixi
|
|
121
|
+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
|
122
|
+
# pixi.lock
|
|
123
|
+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
|
124
|
+
# in the .venv directory. It is recommended not to include this directory in version control.
|
|
125
|
+
.pixi
|
|
126
|
+
|
|
127
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
128
|
+
__pypackages__/
|
|
129
|
+
|
|
130
|
+
# Celery stuff
|
|
131
|
+
celerybeat-schedule
|
|
132
|
+
celerybeat.pid
|
|
133
|
+
|
|
134
|
+
# Redis
|
|
135
|
+
*.rdb
|
|
136
|
+
*.aof
|
|
137
|
+
*.pid
|
|
138
|
+
|
|
139
|
+
# RabbitMQ
|
|
140
|
+
mnesia/
|
|
141
|
+
rabbitmq/
|
|
142
|
+
rabbitmq-data/
|
|
143
|
+
|
|
144
|
+
# ActiveMQ
|
|
145
|
+
activemq-data/
|
|
146
|
+
|
|
147
|
+
# SageMath parsed files
|
|
148
|
+
*.sage.py
|
|
149
|
+
|
|
150
|
+
# Environments
|
|
151
|
+
.env
|
|
152
|
+
.envrc
|
|
153
|
+
.venv
|
|
154
|
+
env/
|
|
155
|
+
venv/
|
|
156
|
+
ENV/
|
|
157
|
+
env.bak/
|
|
158
|
+
venv.bak/
|
|
159
|
+
|
|
160
|
+
# Spyder project settings
|
|
161
|
+
.spyderproject
|
|
162
|
+
.spyproject
|
|
163
|
+
|
|
164
|
+
# Rope project settings
|
|
165
|
+
.ropeproject
|
|
166
|
+
|
|
167
|
+
# mkdocs documentation
|
|
168
|
+
/site
|
|
169
|
+
|
|
170
|
+
# mypy
|
|
171
|
+
.mypy_cache/
|
|
172
|
+
.dmypy.json
|
|
173
|
+
dmypy.json
|
|
174
|
+
|
|
175
|
+
# Pyre type checker
|
|
176
|
+
.pyre/
|
|
177
|
+
|
|
178
|
+
# pytype static type analyzer
|
|
179
|
+
.pytype/
|
|
180
|
+
|
|
181
|
+
# Cython debug symbols
|
|
182
|
+
cython_debug/
|
|
183
|
+
|
|
184
|
+
# PyCharm
|
|
185
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
186
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
187
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
188
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
189
|
+
# .idea/
|
|
190
|
+
|
|
191
|
+
# Abstra
|
|
192
|
+
# Abstra is an AI-powered process automation framework.
|
|
193
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
194
|
+
# Learn more at https://abstra.io/docs
|
|
195
|
+
.abstra/
|
|
196
|
+
|
|
197
|
+
# Visual Studio Code
|
|
198
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
199
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
200
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
201
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
202
|
+
# .vscode/
|
|
203
|
+
# Temporary file for partial code execution
|
|
204
|
+
tempCodeRunnerFile.py
|
|
205
|
+
|
|
206
|
+
# Ruff stuff:
|
|
207
|
+
.ruff_cache/
|
|
208
|
+
|
|
209
|
+
# PyPI configuration file
|
|
210
|
+
.pypirc
|
|
211
|
+
|
|
212
|
+
# Marimo
|
|
213
|
+
marimo/_static/
|
|
214
|
+
marimo/_lsp/
|
|
215
|
+
__marimo__/
|
|
216
|
+
|
|
217
|
+
# Streamlit
|
|
218
|
+
.streamlit/secrets.toml
|
|
219
|
+
|
|
220
|
+
# setuptools-scm generated version file
|
|
221
|
+
src/qcloud_client/_version.py
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Exclude a variety of commonly ignored directories.
|
|
2
|
+
exclude = [
|
|
3
|
+
".git",
|
|
4
|
+
".venv",
|
|
5
|
+
".vscode",
|
|
6
|
+
"__pypackages__",
|
|
7
|
+
"build",
|
|
8
|
+
"dist",
|
|
9
|
+
".gitignore",
|
|
10
|
+
"src/qcloud_client/_version.py"
|
|
11
|
+
]
|
|
12
|
+
|
|
13
|
+
line-length = 200
|
|
14
|
+
indent-width = 4
|
|
15
|
+
|
|
16
|
+
[lint]
|
|
17
|
+
select = ["ALL"]
|
|
18
|
+
ignore = ["ANN001", "ARG002", "BLE001", "C901", "CPY001", "D100", "D102", "D107", "D203", "D213", "D413", "E501", "EM102", "N806", "PLR2004", "PLW0108", "T201", "TRY003", "TRY301", "UP015"]
|
|
19
|
+
|
|
20
|
+
# Allow fix for all enabled rules (when `--fix`) is provided.
|
|
21
|
+
fixable = ["ALL"]
|
|
22
|
+
unfixable = []
|
|
23
|
+
|
|
24
|
+
# Allow unused variables when underscore-prefixed.
|
|
25
|
+
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
|
|
26
|
+
|
|
27
|
+
# Increase maximum number of return statements in a function from 6 to 7
|
|
28
|
+
pylint.max-returns = 7
|
|
29
|
+
|
|
30
|
+
[format]
|
|
31
|
+
quote-style = "double"
|
|
32
|
+
indent-style = "space"
|
|
33
|
+
skip-magic-trailing-comma = false
|
|
34
|
+
line-ending = "auto"
|
|
35
|
+
|
|
36
|
+
# Enable auto-formatting of code examples in docstrings.
|
|
37
|
+
docstring-code-format = false
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 QPIT
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: qcloud-client
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: Python API wrapper for QCloud.
|
|
5
|
+
Author: QPIT
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: Homepage, https://qcloud.dtu.dk
|
|
8
|
+
Project-URL: Source, https://github.com/qpit/qcloud-client
|
|
9
|
+
Project-URL: Issues, https://github.com/qpit/qcloud-client/issues
|
|
10
|
+
Keywords: qcloud,quantum,simulation,api-client
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Classifier: Intended Audience :: Science/Research
|
|
13
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
14
|
+
Requires-Python: >=3.9
|
|
15
|
+
Description-Content-Type: text/markdown
|
|
16
|
+
License-File: LICENSE
|
|
17
|
+
Requires-Dist: httpx>=0.28.1
|
|
18
|
+
Provides-Extra: dev
|
|
19
|
+
Requires-Dist: pytest>=8.3.0; extra == "dev"
|
|
20
|
+
Requires-Dist: pytest-cov>=6.0.0; extra == "dev"
|
|
21
|
+
Requires-Dist: ruff>=0.16.0; extra == "dev"
|
|
22
|
+
Dynamic: license-file
|
|
23
|
+
|
|
24
|
+
# QCloud Client
|
|
25
|
+
|
|
26
|
+
[](https://github.com/qpit/qcloud-client/actions/workflows/lint.yml)
|
|
27
|
+
[](https://github.com/qpit/qcloud-client/blob/main/LICENSE)
|
|
28
|
+
|
|
29
|
+
- [Overview](#overview)
|
|
30
|
+
- [Setup](#setup)
|
|
31
|
+
- [Requirements](#requirements)
|
|
32
|
+
- [Installation](#installation)
|
|
33
|
+
- [Usage](#usage)
|
|
34
|
+
- [Testing](#testing)
|
|
35
|
+
- [Linting](#linting)
|
|
36
|
+
- [Pytest](#pytest)
|
|
37
|
+
- [License](#license)
|
|
38
|
+
|
|
39
|
+
# Overview
|
|
40
|
+
GitHub repository for the Python API wrapper for [QCloud](https://qcloud.dtu.dk), the quantum computing service operated by [QPIT](https://www.fysik.dtu.dk/english/research/qpit/) at the Technical University of Denmark.
|
|
41
|
+
|
|
42
|
+
> [!WARNING]
|
|
43
|
+
> The package is in early development and is not yet ready for stable public use. Expect breaking changes between minor versions until `1.0.0`.
|
|
44
|
+
|
|
45
|
+
# Setup
|
|
46
|
+
## Requirements
|
|
47
|
+
- Python 3.9 or newer
|
|
48
|
+
- An account on [QCloud](https://qcloud.dtu.dk)
|
|
49
|
+
|
|
50
|
+
## Installation
|
|
51
|
+
You can install the package from PyPI:
|
|
52
|
+
```bash
|
|
53
|
+
pip install qcloud-client
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
To install the latest unreleased code directly from the repository, run:
|
|
57
|
+
```bash
|
|
58
|
+
pip install git+https://github.com/qpit/qcloud-client.git@develop
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
# Usage
|
|
62
|
+
The public interface is not yet implemented. Usage examples will be published here alongside the first release that exposes a client.
|
|
63
|
+
|
|
64
|
+
Import the package using `import qcloud_client`
|
|
65
|
+
|
|
66
|
+
# Testing
|
|
67
|
+
## Linting
|
|
68
|
+
Code linting checks are performed by the Ruff package. Read more here: https://docs.astral.sh/ruff/
|
|
69
|
+
|
|
70
|
+
To perform linting checks, run:
|
|
71
|
+
```bash
|
|
72
|
+
ruff check .
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
The linting rules can be configured in the `.ruff.toml` file found in the project's root directory with the available rules listed here: https://docs.astral.sh/ruff/rules/
|
|
76
|
+
|
|
77
|
+
## Pytest
|
|
78
|
+
To run tests with `pytest` and generate a coverage report, run:
|
|
79
|
+
```bash
|
|
80
|
+
pytest -v --cov=. --cov-fail-under=85 --cov-report=term-missing:skip-covered
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
# License
|
|
84
|
+
Released under the MIT License. See [LICENSE](https://github.com/qpit/qcloud-client/blob/main/LICENSE) for the full text.
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# QCloud Client
|
|
2
|
+
|
|
3
|
+
[](https://github.com/qpit/qcloud-client/actions/workflows/lint.yml)
|
|
4
|
+
[](https://github.com/qpit/qcloud-client/blob/main/LICENSE)
|
|
5
|
+
|
|
6
|
+
- [Overview](#overview)
|
|
7
|
+
- [Setup](#setup)
|
|
8
|
+
- [Requirements](#requirements)
|
|
9
|
+
- [Installation](#installation)
|
|
10
|
+
- [Usage](#usage)
|
|
11
|
+
- [Testing](#testing)
|
|
12
|
+
- [Linting](#linting)
|
|
13
|
+
- [Pytest](#pytest)
|
|
14
|
+
- [License](#license)
|
|
15
|
+
|
|
16
|
+
# Overview
|
|
17
|
+
GitHub repository for the Python API wrapper for [QCloud](https://qcloud.dtu.dk), the quantum computing service operated by [QPIT](https://www.fysik.dtu.dk/english/research/qpit/) at the Technical University of Denmark.
|
|
18
|
+
|
|
19
|
+
> [!WARNING]
|
|
20
|
+
> The package is in early development and is not yet ready for stable public use. Expect breaking changes between minor versions until `1.0.0`.
|
|
21
|
+
|
|
22
|
+
# Setup
|
|
23
|
+
## Requirements
|
|
24
|
+
- Python 3.9 or newer
|
|
25
|
+
- An account on [QCloud](https://qcloud.dtu.dk)
|
|
26
|
+
|
|
27
|
+
## Installation
|
|
28
|
+
You can install the package from PyPI:
|
|
29
|
+
```bash
|
|
30
|
+
pip install qcloud-client
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
To install the latest unreleased code directly from the repository, run:
|
|
34
|
+
```bash
|
|
35
|
+
pip install git+https://github.com/qpit/qcloud-client.git@develop
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
# Usage
|
|
39
|
+
The public interface is not yet implemented. Usage examples will be published here alongside the first release that exposes a client.
|
|
40
|
+
|
|
41
|
+
Import the package using `import qcloud_client`
|
|
42
|
+
|
|
43
|
+
# Testing
|
|
44
|
+
## Linting
|
|
45
|
+
Code linting checks are performed by the Ruff package. Read more here: https://docs.astral.sh/ruff/
|
|
46
|
+
|
|
47
|
+
To perform linting checks, run:
|
|
48
|
+
```bash
|
|
49
|
+
ruff check .
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
The linting rules can be configured in the `.ruff.toml` file found in the project's root directory with the available rules listed here: https://docs.astral.sh/ruff/rules/
|
|
53
|
+
|
|
54
|
+
## Pytest
|
|
55
|
+
To run tests with `pytest` and generate a coverage report, run:
|
|
56
|
+
```bash
|
|
57
|
+
pytest -v --cov=. --cov-fail-under=85 --cov-report=term-missing:skip-covered
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
# License
|
|
61
|
+
Released under the MIT License. See [LICENSE](https://github.com/qpit/qcloud-client/blob/main/LICENSE) for the full text.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
|
|
5
|
+
`qcloud-client` is pre-1.0. Only the most recent release receives security fixes; there are no
|
|
6
|
+
long-term support branches, and fixes are not backported to earlier minor versions.
|
|
7
|
+
|
|
8
|
+
| Version | Supported |
|
|
9
|
+
| ------- | ------------------ |
|
|
10
|
+
| 0.1.x | :white_check_mark: |
|
|
11
|
+
| < 0.1 | :x: |
|
|
12
|
+
|
|
13
|
+
If you are running an older version, upgrade to the latest release before reporting an issue.
|
|
14
|
+
|
|
15
|
+
## Reporting a Vulnerability
|
|
16
|
+
**Please do not report security vulnerabilities through public GitHub issues, pull requests, or
|
|
17
|
+
discussions.**
|
|
18
|
+
|
|
19
|
+
Report privately through GitHub Security Advisories:
|
|
20
|
+
|
|
21
|
+
1. Go to the [Security tab](https://github.com/qpit/qcloud-client/security) of this repository.
|
|
22
|
+
2. Select **Report a vulnerability**.
|
|
23
|
+
3. Fill in the advisory form.
|
|
24
|
+
|
|
25
|
+
This opens a private channel visible only to the maintainers. If you are unable to use GitHub
|
|
26
|
+
Security Advisories, contact a maintainer listed in
|
|
27
|
+
[CODEOWNERS](https://github.com/qpit/qcloud-client/blob/main/.github/CODEOWNERS) directly.
|
|
28
|
+
|
|
29
|
+
### What to include
|
|
30
|
+
A report is easiest to act on when it contains:
|
|
31
|
+
|
|
32
|
+
- The version of `qcloud-client` and the Python version you are running.
|
|
33
|
+
- A description of the vulnerability and its impact.
|
|
34
|
+
- Steps to reproduce, ideally a minimal proof of concept.
|
|
35
|
+
- Any suggested mitigation, if you have one.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "qcloud-client"
|
|
3
|
+
dynamic = ["version"]
|
|
4
|
+
description = "Python API wrapper for QCloud."
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
requires-python = ">=3.9"
|
|
7
|
+
license = "MIT"
|
|
8
|
+
license-files = ["LICENSE"]
|
|
9
|
+
authors = [{name = "QPIT"}]
|
|
10
|
+
keywords = ["qcloud", "quantum", "simulation", "api-client"]
|
|
11
|
+
classifiers = [
|
|
12
|
+
"Programming Language :: Python :: 3",
|
|
13
|
+
"Intended Audience :: Science/Research",
|
|
14
|
+
"Topic :: Scientific/Engineering :: Physics",
|
|
15
|
+
]
|
|
16
|
+
dependencies = [
|
|
17
|
+
"httpx>=0.28.1",
|
|
18
|
+
]
|
|
19
|
+
|
|
20
|
+
[project.optional-dependencies]
|
|
21
|
+
dev = [
|
|
22
|
+
"pytest>=8.3.0",
|
|
23
|
+
"pytest-cov>=6.0.0",
|
|
24
|
+
"ruff>=0.16.0",
|
|
25
|
+
]
|
|
26
|
+
|
|
27
|
+
[project.urls]
|
|
28
|
+
Homepage = "https://qcloud.dtu.dk"
|
|
29
|
+
Source = "https://github.com/qpit/qcloud-client"
|
|
30
|
+
Issues = "https://github.com/qpit/qcloud-client/issues"
|
|
31
|
+
|
|
32
|
+
[build-system]
|
|
33
|
+
requires = ["setuptools>=77", "setuptools-scm>=8"]
|
|
34
|
+
build-backend = "setuptools.build_meta"
|
|
35
|
+
|
|
36
|
+
[tool.setuptools_scm]
|
|
37
|
+
version_file = "src/qcloud_client/_version.py"
|
|
38
|
+
|
|
39
|
+
[tool.pytest.ini_options]
|
|
40
|
+
testpaths = ["tests"]
|
|
41
|
+
pythonpath = ["src"]
|
|
42
|
+
addopts = "-v --cov=qcloud_client --cov-report=term-missing:skip-covered"
|
|
43
|
+
|
|
44
|
+
[tool.coverage.run]
|
|
45
|
+
source = ["src/qcloud_client"]
|
|
46
|
+
omit = ["src/qcloud_client/_version.py"]
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"""Python API wrapper for QCloud."""
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# file generated by vcs-versioning
|
|
2
|
+
# don't change, don't track in version control
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
__all__ = [
|
|
6
|
+
"__version__",
|
|
7
|
+
"__version_tuple__",
|
|
8
|
+
"version",
|
|
9
|
+
"version_tuple",
|
|
10
|
+
"__commit_id__",
|
|
11
|
+
"commit_id",
|
|
12
|
+
]
|
|
13
|
+
|
|
14
|
+
version: str
|
|
15
|
+
__version__: str
|
|
16
|
+
__version_tuple__: tuple[int | str, ...]
|
|
17
|
+
version_tuple: tuple[int | str, ...]
|
|
18
|
+
commit_id: str | None
|
|
19
|
+
__commit_id__: str | None
|
|
20
|
+
|
|
21
|
+
__version__ = version = '0.0.1'
|
|
22
|
+
__version_tuple__ = version_tuple = (0, 0, 1)
|
|
23
|
+
|
|
24
|
+
__commit_id__ = commit_id = 'g932fac959'
|
|
File without changes
|
|
File without changes
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: qcloud-client
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: Python API wrapper for QCloud.
|
|
5
|
+
Author: QPIT
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: Homepage, https://qcloud.dtu.dk
|
|
8
|
+
Project-URL: Source, https://github.com/qpit/qcloud-client
|
|
9
|
+
Project-URL: Issues, https://github.com/qpit/qcloud-client/issues
|
|
10
|
+
Keywords: qcloud,quantum,simulation,api-client
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Classifier: Intended Audience :: Science/Research
|
|
13
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
14
|
+
Requires-Python: >=3.9
|
|
15
|
+
Description-Content-Type: text/markdown
|
|
16
|
+
License-File: LICENSE
|
|
17
|
+
Requires-Dist: httpx>=0.28.1
|
|
18
|
+
Provides-Extra: dev
|
|
19
|
+
Requires-Dist: pytest>=8.3.0; extra == "dev"
|
|
20
|
+
Requires-Dist: pytest-cov>=6.0.0; extra == "dev"
|
|
21
|
+
Requires-Dist: ruff>=0.16.0; extra == "dev"
|
|
22
|
+
Dynamic: license-file
|
|
23
|
+
|
|
24
|
+
# QCloud Client
|
|
25
|
+
|
|
26
|
+
[](https://github.com/qpit/qcloud-client/actions/workflows/lint.yml)
|
|
27
|
+
[](https://github.com/qpit/qcloud-client/blob/main/LICENSE)
|
|
28
|
+
|
|
29
|
+
- [Overview](#overview)
|
|
30
|
+
- [Setup](#setup)
|
|
31
|
+
- [Requirements](#requirements)
|
|
32
|
+
- [Installation](#installation)
|
|
33
|
+
- [Usage](#usage)
|
|
34
|
+
- [Testing](#testing)
|
|
35
|
+
- [Linting](#linting)
|
|
36
|
+
- [Pytest](#pytest)
|
|
37
|
+
- [License](#license)
|
|
38
|
+
|
|
39
|
+
# Overview
|
|
40
|
+
GitHub repository for the Python API wrapper for [QCloud](https://qcloud.dtu.dk), the quantum computing service operated by [QPIT](https://www.fysik.dtu.dk/english/research/qpit/) at the Technical University of Denmark.
|
|
41
|
+
|
|
42
|
+
> [!WARNING]
|
|
43
|
+
> The package is in early development and is not yet ready for stable public use. Expect breaking changes between minor versions until `1.0.0`.
|
|
44
|
+
|
|
45
|
+
# Setup
|
|
46
|
+
## Requirements
|
|
47
|
+
- Python 3.9 or newer
|
|
48
|
+
- An account on [QCloud](https://qcloud.dtu.dk)
|
|
49
|
+
|
|
50
|
+
## Installation
|
|
51
|
+
You can install the package from PyPI:
|
|
52
|
+
```bash
|
|
53
|
+
pip install qcloud-client
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
To install the latest unreleased code directly from the repository, run:
|
|
57
|
+
```bash
|
|
58
|
+
pip install git+https://github.com/qpit/qcloud-client.git@develop
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
# Usage
|
|
62
|
+
The public interface is not yet implemented. Usage examples will be published here alongside the first release that exposes a client.
|
|
63
|
+
|
|
64
|
+
Import the package using `import qcloud_client`
|
|
65
|
+
|
|
66
|
+
# Testing
|
|
67
|
+
## Linting
|
|
68
|
+
Code linting checks are performed by the Ruff package. Read more here: https://docs.astral.sh/ruff/
|
|
69
|
+
|
|
70
|
+
To perform linting checks, run:
|
|
71
|
+
```bash
|
|
72
|
+
ruff check .
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
The linting rules can be configured in the `.ruff.toml` file found in the project's root directory with the available rules listed here: https://docs.astral.sh/ruff/rules/
|
|
76
|
+
|
|
77
|
+
## Pytest
|
|
78
|
+
To run tests with `pytest` and generate a coverage report, run:
|
|
79
|
+
```bash
|
|
80
|
+
pytest -v --cov=. --cov-fail-under=85 --cov-report=term-missing:skip-covered
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
# License
|
|
84
|
+
Released under the MIT License. See [LICENSE](https://github.com/qpit/qcloud-client/blob/main/LICENSE) for the full text.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
.gitignore
|
|
2
|
+
.ruff.toml
|
|
3
|
+
LICENSE
|
|
4
|
+
README.md
|
|
5
|
+
SECURITY.md
|
|
6
|
+
pyproject.toml
|
|
7
|
+
requirements.txt
|
|
8
|
+
.github/CODEOWNERS
|
|
9
|
+
.github/dependabot.yaml
|
|
10
|
+
.github/workflows/lint.yml
|
|
11
|
+
.github/workflows/release.yml
|
|
12
|
+
src/qcloud_client/__init__.py
|
|
13
|
+
src/qcloud_client/_version.py
|
|
14
|
+
src/qcloud_client/client.py
|
|
15
|
+
src/qcloud_client/core.py
|
|
16
|
+
src/qcloud_client.egg-info/PKG-INFO
|
|
17
|
+
src/qcloud_client.egg-info/SOURCES.txt
|
|
18
|
+
src/qcloud_client.egg-info/dependency_links.txt
|
|
19
|
+
src/qcloud_client.egg-info/requires.txt
|
|
20
|
+
src/qcloud_client.egg-info/scm_file_list.json
|
|
21
|
+
src/qcloud_client.egg-info/scm_version.json
|
|
22
|
+
src/qcloud_client.egg-info/top_level.txt
|
|
23
|
+
tests/.gitkeep
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
{
|
|
2
|
+
"files": [
|
|
3
|
+
".github/CODEOWNERS",
|
|
4
|
+
".github/dependabot.yaml",
|
|
5
|
+
".github/workflows/lint.yml",
|
|
6
|
+
".github/workflows/release.yml",
|
|
7
|
+
".gitignore",
|
|
8
|
+
".ruff.toml",
|
|
9
|
+
"LICENSE",
|
|
10
|
+
"README.md",
|
|
11
|
+
"SECURITY.md",
|
|
12
|
+
"pyproject.toml",
|
|
13
|
+
"requirements.txt",
|
|
14
|
+
"src/qcloud_client/__init__.py",
|
|
15
|
+
"src/qcloud_client/client.py",
|
|
16
|
+
"src/qcloud_client/core.py",
|
|
17
|
+
"tests/.gitkeep"
|
|
18
|
+
]
|
|
19
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
qcloud_client
|
|
File without changes
|