qvc 1.0.0

Quantum Version Control CLI

QVC – Quantum Version Control

A command-line version control system for quantum circuits.

QVC is a Python-based CLI tool that enables developers and researchers to track, manage, and compare versions of quantum circuits built using Qiskit. Inspired by traditional version control systems, QVC introduces staging, committing, and diffing capabilities specifically tailored for quantum computing workflows.

It allows users to stage circuits, commit versions, analyze circuit differences, and restore previous circuit states, making it useful for students, researchers, and quantum developers.

Table of Contents

• Table of Contents
• Features
• Installation / Setup
• Usage
  • General User
  • Developer
• Screenshots / Demo
• Project Structure
• Configuration
• Contributing Guidelines
• Roadmap
• Built With / Tech Stack
• Authors / Acknowledgements
• License
• Support / Contact

Features

• ⚛ Quantum Circuit Versioning – Track and manage different versions of quantum circuits.
• 📦 Staging System – Add circuits to a staging area before committing.
• 📝 Commit History – Save circuit versions with commit messages.
• 🔍 Circuit Difference Analysis – Compare circuits using text, parameter, and state differences.
• 📊 Status Monitoring – View staged and committed circuits in summary or detailed form.
• ♻ Restore Functionality – Restore circuits to previously committed versions.
• 🖥 Command Line Interface – Lightweight CLI workflow similar to traditional version control tools.

Installation / Setup

Prerequisites

• Python 3.9+
• pip package manager

Steps for Installation

# Clone repository
git clone https://github.com/Pratham-Vishwakarma/QVC.git
cd QVC

Install the CLI tool:

pip install .

After installation, you can run:

qvc help

Usage

General User

Initialize a QVC project:

qvc init

Add a circuit file:

qvc add circuit.py

Add all circuit files in the directory:

qvc add .

Commit staged circuits:

qvc commit "Initial circuit commit"

Check status:

qvc status stage summary

View circuit differences:

qvc diff text detailed

Restore previous version:

qvc restore

Developer

Install in editable mode:

pip install -e .

Run CLI directly for testing:

python -m qvc.cli

Modify modules inside the qvc directory to extend functionality.

Example workflow:

qvc init
qvc add bell.py
qvc commit "Initial circuit"
qvc diff text summary

Project Structure

qvc/
│
├── qvc/
│   ├── cli.py
│   ├── add.py
│   ├── commit.py
│   ├── diff_text.py
│   ├── diff_param.py
│   ├── diff_state.py
│   ├── status.py
│   └── restore.py
│
├── pyproject.toml
├── README.md
└── LICENSE

Configuration

No additional configuration required.

Initialize QVC in your project directory:

qvc init

Contributing Guidelines

1. Fork the repository.
2. Create a feature branch.

git checkout -b feature-name

3. Commit changes.

git commit -m "Add feature"

4. Push to branch.

git push origin feature-name

5. Open a Pull Request.

Roadmap

• Add commit history viewer
• Add circuit visualization
• Add remote repository support
• Improve circuit parsing using AST
• Add merge functionality for circuits

Built With / Tech Stack

Component	Purpose
Python	Core CLI implementation
Qiskit	Quantum circuit framework
NumPy	Numerical operations
AST (Python)	Static code analysis
pip	Package management

Authors / Acknowledgements

• Pratham Vishwakarma – Developer
• Raj Parmar – Developer

Inspired by modern version control workflows and quantum development tools.

Special thanks to the Qiskit community for advancing quantum computing.

License

QVC is licensed under the MIT License.

Support / Contact

• Email: [e-mail]
• GitHub: https://github.com/Pratham-Vishwakarma
• LinkedIn: https://www.linkedin.com/in/pratham-vishwakarma/
• X: https://www.x.com/pratham1826/