Python SDK for interacting with ExaVault API
Project description
ExaVault Python API SDK - v2.0
Welcome to ExaVault's PHP code library for our v2 API. Use our API to interact with all aspects of the service the same way our web portal would. The library is generated from our API's public swagger YAML file
Requirements
The SDK supports the following versions of Python:
- Python 2 versions 2.7.9 and later
- Python 3 versions 3.4 and later
You must also have an ExaVault API key and access token. For more information, please refer to our API Documentation or contact support@exavault.com for details.
Installation
- Clone the repo
git clone https://github.com/ExaVault/evapi-python.git evapi-python
or manually download the library. - Run setup script
python setup.py install
Depending on your python setup, you may need to run the script as root; e.g.sudo python setup.py install
Getting started
Install the latest SDK using pip:
pip install exavault
Alternatively, you can download or clone the sdk from [Python SDK] and then install the SDK by running Setuptools in the SDK installation directory:
python setup.py install
Sample Code
For a gentle introduction to using Python code with ExaVault's API, check out our code samples. Follow the instructions in that repository's README to run the sample scripts, which will demonstrate how to use several of the APIs to interact with your ExaVault account.
Writing Your Own Code
When you're ready to write your own code using this library, you'll need to:
- Install our code library in your project, either with
pip install exavault
or by downloading this repository and importing the package directly - Provide your API key and access token with every function method on the Api classes
- Whenever you instantiate an Api object (ResourcesApi, UsersApi, etc.), override the configuration to point the code at the correct API URL:
from exavault import AccountApi
ACCOUNT_URL = "https://YOUR_ACCOUNT_NAME_HERE.exavault.com/api/v2/";
account_api = AccountApi()
account_api.api_client.configuration.host = ACCOUNT_URL
from exavault import ResourcesApi
ACCOUNT_URL = "https://YOUR_ACCOUNT_NAME_HERE.exavault.com/api/v2/";
resources_api = ResourcesApi()
resources_api.api_client.configuration.host = ACCOUNT_URL
from exavault import NotificationsApi
ACCOUNT_URL = "https://YOUR_ACCOUNT_NAME_HERE.exavault.com/api/v2/";
notifications_api = NotificationsApi()
notifications_api.api_client.configuration.host = ACCOUNT_URL
Author
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for exavault-2.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e53b7214ac6e6b6624fc5342fa5d4b8af51c3f559e576982fa3f699772168323 |
|
MD5 | d6ef4e95990544cda92fa86002c9cc3c |
|
BLAKE2b-256 | 0899560c7c88b4d62cae6fb4c3c817c0e79cdda54315c8c4ef7ab99edc1f0a7b |