Local Installation
Last updated
Last updated
The following steps guide you through this process of setting up vBase Python SDK in your local environment:
Note for Windows users: If you’re on Windows, the following instructions will work on the Windows Subsystem for Linux (WSL). WSL provides a Linux environment on your Windows OS. Please follow
Please , sign-up, and retrieve the API Key from your user profile if you wish to have the simplest experience. The API key is needed to access the forwarder API service. This service simplifies commitment and validation operations but is not required for interacting with vBase.
Create the directory where you want to clone vBase repositories and switch to this directory by running:
Install the vbase
python package that provides the vBase Python SDK from GitHub:
Clone the vbase-py-samples
GitHub repository:
Option 1: Copy your existing environment: If you have previously configured vBase access, for instance, when using the vbase-py-tools
package, you can re-use those settings by copying .env
file to the vbase-py-samples
folder:
Below is a summary of the configuration settings from the resulting .env
file:
You can keep these values in the .env
file in the working directory of your Python code or add them to your command environment.
You can make and verify commitments. Please review the samples and their documentation for additional info.
Option 2: Create a new environment:
If this is your first time working with vBase, you should configure new settings.
Please install the vbase-py-tools
package and follow the setup instructions using the config_env
script provided in that package as instructed at the following link: .