See https://docs.trustar.co/ for the official documentation to the TruSTAR Python SDK.
To install, run
pip install trustar
If the package has been previously installed, upgrade to the latest version with
pip install --upgrade trustar
To uninstall, simply run
pip uninstall trustar
For a quick tutorial on using this package, follow the guide at https://docs.trustar.co/sdk/quick_start.html.
More examples can be found within this repository under trustar/examples
To setup this project for development, you need to have pipenv installed and follow the next instructions:
-
Setup a virtual environment:
pipenv install --dev
-
Activate the virtualenv:
pipenv shell
-
Install this package in editable mode:
pip install -e .
Should you need to create a requirements.txt file to manage a Python 2.7 virtualenv do:
pipenv run pip freeze > requirements.txt
Note: you can use pipenv too to create a 2.7 venv, check the pipenv docs for that.
This package is compatible with both Python 2 and 3. Ensure that any changes made maintain this cross-compatibility.