Common setup issues
Trouble getting started with Terality? This page may help. If it doesn't, don't hesitate to get in touch at support@terality.com!
Last updated
Trouble getting started with Terality? This page may help. If it doesn't, don't hesitate to get in touch at support@terality.com!
Last updated
pip may display this error message when trying to install the Terality package on an unsupported Python version (3.6 or older).
Please ensure you are running Python 3.7 or newer. You can get your current Python version by running the following Python code:
If you are running Python 3.6 or older, please install a more recent Python version to use Terality. We suggest using pyenv to manage several Python versions.
If you need help with installing a newer Python version, our friendly support is always ready to help (email support@terality.com, or use the chat bubble on app.terality.com).
Depending on your setup, you might encounter dependency issues when installing the Terality package in the default Google Colab environment. If you see such a message, simply click the RESTART RUNTIME button at the bottom.
There may be several causes for an authentication error.
In most situations, this error can be fixed by:
Going again through all the setup steps listed on https://app.terality.com.
then restarting your notebook kernel (or Python interpreter).
If that doesn't fix the issue, we'd be happy to help! Email us at support@terality.com or use the chat on app.terality.com.
Possible causes for this error include:
Did you run terality account configure?
You need to configure the Terality client before being able to use it. Follow the quickstart guide on https://app.terality.com.
Did you restart your Python interpreter or notebook kernel?
Sometimes, the Terality client may be using an out-of-date configuration. To be sure that your credentials are correctly loaded, restart your notebook kernel, or restart your Python interpreter.
Did you generate a new API key in the dashboard?
Currently, Terality only supports one API key per user. When you generate a new API key, old API keys are marked as invalid. You need to run the quickstart guide again with the new API key: follow the steps on https://app.terality.com.
The Terality client could not find the Terality configuration and credentials on this machine.
If you don't have a Terality account yet, please follow the guide to get started with a free account:
If you already have a Terality account, you can follow the instructions at https://app.terality.com to configure the client.
You can see this message while trying to run the Terality CLI in a terminal (such as when running terality account create). It means that the Terality CLI is not correctly installed in your current Python environment.
First, ensure that terality is correctly installed in the current Python environment: in the same terminal, run pip install --upgrade --force-reinstall terality and retry.
If that doesn't solve the issue, check that the previous command does not output any warning looking like
WARNING: The script terality is installed in /Users/<you>/Library/Python/3.7/bin which is not on PATH.
If you see this warning, you have two solutions:
Use python -m terality instead of terality. For instance, use python -m terality account configure instead of terality account configure.
Add the folder mentioned by the warning to your PATH. If you are using bash, you can refer to https://gist.github.com/nex3/c395b2f8fd4b02068be37c961301caa7.
In a notebook, you may get the following error when running terality account configure:
This error is caused by forgetting the exclamation mark at the beginning of the command. To fix that, prepend an exclamation mark at the beginning of the cell:
When following the quickstart instructions from https://app.terality.com, be sure to use the instructions for a notebook (and not for a terminal).
When running in a notebook the following command:
the command will display "Your Terality API key:" then be stuck.
To fix that, add the API key to the command:
When following the quickstart instructions from https://app.terality.com, be sure to use the instructions for a notebook (and not for a terminal).
Terality frequently releases new client versions that include important fixes. We recommend always using the latest version of the client. In some cases, upgrading the client may solve an error you're encountering.
We have a how-to guide about upgrading your client version here:
This message is due to the way some versions of pip resolve dependencies, and is harmless. To make this message disappear and reduce installation times, consider upgrading your pip version:
