Skip to content

Welcome to the QubiPy official documentation, a Python Library for the QUBIC RPC API

Beta Version: 0.4.0

QubiPy is currently in beta. While functional, some features might change before the stable release.

QubiPy is a Python library that provides RPC and Core client functionality. You can interact quickly and easily with the Qubic RPC API using the different methods offered by this library.

release python Python Package Code Quality license dependabot

Main Features

  • RPC endpoints
  • CORE endpoints
  • QX endpoints
  • Robust core client functionality
  • Robust error handling

Prerequisites

Before installing QubiPy, make sure you have:

  • Python 3.10 or higher
  • pip (Python package installer)
  • Basic knowledge of the QUBIC API

Version Check

You can check your Python version by running: 

python --version

Getting Started

Installation

Dependencies

All dependencies will be installed automatically when you install QubiPy through pip:

To install QubiPy, run:

pip install qubipy

Basic example

Let's see some basic examples of the use of the library.

Get the latest tick

Here's a simple example of how to use QubiPy. For example, If you want to get the latest tick from the RPC server :

from qubipy.rpc import rpc_client

RPC = rpc_client.QubiPy_RPC()
tick = RPC.get_latest_tick()

print(f"Tick: {tick}")

# 17650910

To see more advanced examples, please visit Advances examples

Contributing

We welcome all contributions to QubiPy! Whether you want to:

  • Fix a bug
  • Add a new feature
  • Improve documentation
  • Submit suggestions

You can learn how to contribute here

Support Our Work (Donations)

Your Contribution Matters

QubiPy is developed and maintained by QubiPy Labs as a free, open-source project for the Qubic community.

Our dedication to providing high-quality tools is driven by passion, but maintaining and enhancing the library requires time, effort, and resources.

If you find QubiPy valuable and wish to support its continued development, any contribution is greatly appreciated.

Your donations help us cover operational costs, dedicate more time to new features, bug fixes, and comprehensive documentation, ensuring QubiPy remains a robust tool for everyone.

You can send your generous contributions to the following addresses:

  • QUBIC : CNSLISZCRHAVHADBQCZWVYAVTYXCVNQREGVVTWKBLHSJXFHRFEGNLORCHRSE
  • USDT (ETH, ARB, BSC or Polygon) : 0x453471Cc01868895b833841Ce7DbaE11fd9D1933

A huge thank you for being a part of the QubiPy journey!

Community

Get Help

Need help? Join our Discord community for quick support and discussions!