Crux Python Client¶
The Crux Python Client, provided as the crux
Python package, it a way to interact with the Crux platform from Python. It provides functionality such as uploading, downloading, and searching for files.
Installation (macOS)¶
Install a recent version of Python, and a Python dependency and virtual environment manager:
brew install python
brew install pipenv
Install crux
in a virtual environment, and get a shell in that environment:
pipenv install "crux==0.0.2"
pipenv shell
Getting Started¶
Create a file, like example.py, and use the crux
module:
import os
from crux import Crux
conn = Crux(api_key="YOUR_API_KEY")
identity = conn.whoami()
print("I am", identity.email)
Run the script:
python3 example.py
Examples¶
Examples for specific topics: