Install a Python Client
On this page: Everything you need to install and run a TerminusDB Python client.
Key topics
Requirements
A list of prerequisite components depending on your operating system. Click on the required component to download it from the provider's website.
Installation requirements
Required
Version
Required to:
Linux
macOS
Windows
Install steps
Install and use the TerminusDB Python client with the following steps.
Install the TerminusDB bootstrap
Install the latest Python components
In an administrator shell, run the command below to update
pip, setuptools, and wheel.Linux/macOS
Windows
1
python3 -m pip install --upgrade pip setuptools wheel
Copied!
1
py -m pip install --upgrade pip setuptools wheel
Copied!
Install the TerminusDB Python client
Choose one of the following Python client install options.
Install the core
Install the core Python client. The core includes
WOQLClient and WOQLQuery.1
python -m pip install terminusdb-client
Copied!
Install with dataframe
Install the Python client with the WOQL
dataframe. The WOQLDataFrame enables query results to be converted to different formats such as Pandas.1
python -m pip install terminusdb-client[dataframe]
Copied!
If you are using a shell other than
bash, such as zsh, you may need to use quotes.1
python -m pip install 'terminusdb-client[dataframe]'
Copied!
Install from source
Build and install the Python client from source.
1
python -m pip install git+https://github.com/terminusdb/terminusdb-client-python.git
Copied!
See also
Start with a Client API
Client reference
Tutorials
Last modified 1mo ago