qcloud-client 0.0.1__py3-none-any.whl
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/__init__.py +1 -0
- qcloud_client/_version.py +24 -0
- qcloud_client/client.py +0 -0
- qcloud_client/core.py +0 -0
- qcloud_client-0.0.1.dist-info/METADATA +84 -0
- qcloud_client-0.0.1.dist-info/RECORD +9 -0
- qcloud_client-0.0.1.dist-info/WHEEL +5 -0
- qcloud_client-0.0.1.dist-info/licenses/LICENSE +21 -0
- qcloud_client-0.0.1.dist-info/top_level.txt +1 -0
|
@@ -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 = None
|
qcloud_client/client.py
ADDED
|
File without changes
|
qcloud_client/core.py
ADDED
|
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,9 @@
|
|
|
1
|
+
qcloud_client/__init__.py,sha256=WyZgb-6ZYmz75A4bl9VN16aKiuk6ybM1r7n4VI9m_uA,37
|
|
2
|
+
qcloud_client/_version.py,sha256=8OsTLsIVB9D0HdPTmt5rVwyVUBe9xTVGkRslXicxzkM,520
|
|
3
|
+
qcloud_client/client.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
4
|
+
qcloud_client/core.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
5
|
+
qcloud_client-0.0.1.dist-info/licenses/LICENSE,sha256=_tOa88ETYmuR6cJBxNH1ReQeLdMOYBWi7-6iuU4FANQ,1061
|
|
6
|
+
qcloud_client-0.0.1.dist-info/METADATA,sha256=t2fPQyw49RwwW-0T9BF6e07_7dcpG1JmzlLYmCXfBeM,2908
|
|
7
|
+
qcloud_client-0.0.1.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
|
|
8
|
+
qcloud_client-0.0.1.dist-info/top_level.txt,sha256=c8x-Wq8eDOEDZnccaU4abpWgX5ou5mMVScS_844tKoA,14
|
|
9
|
+
qcloud_client-0.0.1.dist-info/RECORD,,
|
|
@@ -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 @@
|
|
|
1
|
+
qcloud_client
|