Metadata-Version: 2.4
Name: qcoder
Version: 0.1.0a0
Summary: Pre-alpha: deterministic circuit feature extraction and QASM analysis (local circuit intelligence).
Author-email: Quantum Ready Solutions <support@qcoder.ai>
Maintainer-email: Quantum Ready Solutions <support@qcoder.ai>
License-Expression: Apache-2.0
Project-URL: Homepage, https://qcoder.ai
Project-URL: Documentation, https://qcoder.ai/manual/
Project-URL: Repository, https://github.com/QuantumReadySolutions/qCoder
Project-URL: Issues, https://github.com/QuantumReadySolutions/qCoder/issues
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: numpy
Provides-Extra: qiskit
Requires-Dist: qiskit>=1.0; extra == "qiskit"
Dynamic: license-file

# qCoder

**qCoder** is a **pre-alpha**, **local-first** quantum circuit intelligence toolkit focused on **deterministic OpenQASM analysis** and **schema-locked circuit feature extraction**. It ships a small CLI and optional **Qiskit** intake; APIs and flags may change while the project is early.

**Company / legal:** Quantum Ready Solutions. **Product documentation:** [qcoder.ai](https://qcoder.ai) (manual at [qcoder.ai/manual/](https://qcoder.ai/manual/)). **Source:** [github.com/QuantumReadySolutions/qCoder](https://github.com/QuantumReadySolutions/qCoder). **Support:** [support@qcoder.ai](mailto:support@qcoder.ai).

## Scope and interpretation

qCoder produces **structured, deterministic outputs** from circuit sources (primarily OpenQASM) for workflows such as review, regression checks, and batch datasets. It is **not** a hosted service and does not provide accounts, payments, or managed execution. Combine outputs with **your own** validation, simulators, or hardware runs when you need execution evidence.

## Package layout (supported public surface)

In this **pre-alpha** release, treat the **supported surface** as:

- **`qcoder analyze`** — single-circuit extraction (human or `--json`).
- **`qcoder batch`** — directory batch to JSONL.
- **`qcoder[qiskit]`** — optional QuantumCircuit intake that feeds the same schema as OpenQASM.
- **Documented feature schema** — see [qcoder.ai manual — Feature reference](https://qcoder.ai/manual/feature-reference/) (and `engines/feature_extraction/features/schema_v0.py` alongside the extractor).

Additional Python modules ship in **`src/qcoder`** for ongoing research or prototyping (for example tooling or engines not surfaced by those commands). Unless called out explicitly in **`README`** or **`docs/`** here or on **qcoder.ai**, they do **not** carry the same compatibility expectations as the CLI and schema above.

Public architecture notes live in **`docs/architecture.md`**.

## Install

```bash
pip install qcoder
```

Pre-release versions may use a pre-release segment (e.g. `0.1.0a0`) on PyPI when published.

**Optional Qiskit** adapter (only if you need `QuantumCircuit` intake):

```bash
pip install "qcoder[qiskit]"
```

Requires **Python 3.11+**. Runtime dependency: **NumPy**.

## CLI quickstart

```bash
qcoder analyze path/to/circuit.qasm
qcoder analyze path/to/circuit.qasm --json
qcoder batch path/to/qasm_dir/ --out features.jsonl
```

## Develop / test (from a clone)

```bash
python -m venv .venv
source .venv/bin/activate
pip install -e ".[qiskit]"
pip install pytest
pytest -q
```

## License

Licensed under the **Apache License 2.0**. See `LICENSE` and `NOTICE`.
