Metadata-Version: 2.4
Name: qcloud-client
Version: 0.0.1
Summary: Python API wrapper for QCloud.
Author: QPIT
License-Expression: MIT
Project-URL: Homepage, https://qcloud.dtu.dk
Project-URL: Source, https://github.com/qpit/qcloud-client
Project-URL: Issues, https://github.com/qpit/qcloud-client/issues
Keywords: qcloud,quantum,simulation,api-client
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx>=0.28.1
Provides-Extra: dev
Requires-Dist: pytest>=8.3.0; extra == "dev"
Requires-Dist: pytest-cov>=6.0.0; extra == "dev"
Requires-Dist: ruff>=0.16.0; extra == "dev"
Dynamic: license-file

# QCloud Client

[![Lint](https://github.com/qpit/qcloud-client/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/qpit/qcloud-client/actions/workflows/lint.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/qpit/qcloud-client/blob/main/LICENSE)

- [Overview](#overview)
- [Setup](#setup)
    - [Requirements](#requirements)
    - [Installation](#installation)
- [Usage](#usage)
- [Testing](#testing)
    - [Linting](#linting)
    - [Pytest](#pytest)
- [License](#license)

# Overview
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.

> [!WARNING]
> 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`.

# Setup
## Requirements
- Python 3.9 or newer
- An account on [QCloud](https://qcloud.dtu.dk)

## Installation
You can install the package from PyPI:
```bash
pip install qcloud-client
```

To install the latest unreleased code directly from the repository, run:
```bash
pip install git+https://github.com/qpit/qcloud-client.git@develop
```

# Usage
The public interface is not yet implemented. Usage examples will be published here alongside the first release that exposes a client.

Import the package using `import qcloud_client`

# Testing
## Linting
Code linting checks are performed by the Ruff package. Read more here: https://docs.astral.sh/ruff/

To perform linting checks, run:
```bash
ruff check .
```

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/

## Pytest
To run tests with `pytest` and generate a coverage report, run:
```bash
pytest -v --cov=. --cov-fail-under=85 --cov-report=term-missing:skip-covered
```

# License
Released under the MIT License. See [LICENSE](https://github.com/qpit/qcloud-client/blob/main/LICENSE) for the full text.
