A Python Implementation of XQ Message SDK (V.2) which provides convenient access to the XQ Message API. Full Package Documentation.
Supports Python 3.8 | 3.9 | 3.10
XQ Message is an encryption-as-a-service (EaaS) platform which gives you the tools to encrypt and route data to and from devices like mobile phones, IoT, and connected devices that are at the "edge" of the internet. The XQ platform is a lightweight and highly secure cybersecurity solution that enables self protecting data for perimeterless zero trust data protection, even to devices and apps that have no ability to do so natively.
XQ is about the secure transfer of data in motion and throughout its lifecycle. XQ protects, controls, and tracks all the interactions with the data. XQ monitors what entities attempt access, where they are located and when the interaction occurs.
pip install git+ssh://git@github.com/XQ-Message-Inc/python-sdk.git@main#egg=xq-sdk
git clone git@github.com:XQ-Message-Inc/python-sdk.git
pip install -e .
In order to utilize the XQ SDK and interact with XQ servers you will need both the General
and Dashboard
API keys. To generate these keys, follow these steps:
General
key for the XQ framework API.Dashboard
key for the XQ dashboard API.To initialize an XQ SDK instance in your Python application, provide the generated XQ_API_KEY
(General) and/or XQ_DASHBOARD_API_KEY
(Dashboard) API keys to the XQ
class.
This can be done via:
import xq
xq = XQ(
api_key="YOUR_XQ_API_KEY",
dashboard_api_key="YOUR_DASHBOARD_API_KEY"
)
Note: You only need to generate one SDK instance for use across your application.
There are detailed usage examples available in the examples folder of this project.
Roundtrip Encryption Examples:
pytest
coverage run -m pytest
coverage html
sphinx-apidoc -f -o docs/ xq/
cd docs
make html