Install Python Client
Everything you need to install and run a TerminusDB Python client
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 |
---|---|---|---|---|---|
Latest | Install the TerminusDB server as a Docker container. | ✔ | ✔ | ✔ | |
Latest | Build and install the Python client from source. | ✔ | ✔ | ✔ | |
Latest | Use the Python CLI (recommended shell.) | ✔ | ✔ | ✔ | |
3.6+ | Use the TerminusDB Python client. | ✔ | ✔ | ✔ |
Install and use the TerminusDB Python client with the following steps.
In an administrator shell, run the command below to update
pip
, setuptools
, and wheel
.Linux/macOS
Windows
python3 -m pip install --upgrade pip setuptools wheel
py -m pip install --upgrade pip setuptools wheel
Choose one of the following Python client install options.
Install the core Python client. The core includes
WOQLClient
and WOQLQuery
.python -m pip install terminusdb-client
Install the Python client with the WOQL
dataframe
. The WOQLDataFrame enables query results to be converted to different formats such as Pandas.python -m pip install terminusdb-client[dataframe]
If you are using a shell other than
bash
, such as zsh
, you may need to use quotes.python -m pip install 'terminusdb-client[dataframe]'
Build and install the Python client from source.
python -m pip install git+https://github.com/terminusdb/terminusdb-client-python.git
Last modified 23d ago