Private ID Python SDK
Technical Documentation for Privacy-Centric, AI/ML-Powered Age Verification at the Edge
Installation Guide
The CryptoNets™ Python SDK is designed to support fault-tolerant, multi-threaded programming, as well as containerized environments. It is compatible with Docker and Kubernetes, enabling elastic scaling and load balancing for optimal performance.
Supported Python Versions
We recommend using the latest version of Python. This SDK supports Python 3.6 and newer.
Dependencies
CryptoNets™ SDK relies on a few key libraries for image processing, which will be installed automatically. If these libraries are already present, the SDK will detect and use them:
Numpy
Provides essential functions for array-based image manipulation.Pillow
Offers functionalities for reading and converting images to required formats.
Using Virtual Environments
We recommend using a virtual environment to manage dependencies for your project, both in development and production. Virtual environments help you avoid conflicts between different project dependencies, as each environment isolates the required libraries and Python versions.
Python includes the built-in venv module, which allows you to create virtual environments easily.
Creating a Virtual Environment
Create a project folder and a venv folder within it:
mkdir myproject
cd myproject
python3 -m venv venv
On Windows:
py -3 -m venv venv
Activating the Environment
Before working on your project, activate the virtual environment:
. venv/bin/activate
On Windows:
venv\Scripts\activate
Your shell prompt will change to indicate that the environment is activated.
Installing CryptoNets™ SDK
Once the environment is activated, install the SDK with the following command:
pip3 install cryptonets_python_sdk
Upgrading CryptoNets™ SDK
To upgrade to the latest version of the CryptoNets™ SDK, use:
pip3 install --upgrade --no-cache cryptonets_python_sdk
By following these steps, you’ll ensure a seamless setup for developing with the CryptoNets™ Python SDK.