description: Installing and setting up the Datapane library and API on your device
Datapane's Python library and CLI can be installed using either
pip on macOS, Windows, or Linux. Datapane supports Python 3.6 - 3.10.
Instructions for installing Python can be found at https://wiki.python.org/moin/BeginnersGuide/Download.
If you use
conda, you can install it with:
Conda sometimes installs an older version of datapane. If you receive errors, please check the version and try running
conda update --all or try in a new conda environment (
conda create -n ENV and
conda activate ENV)
If you use
pip, you can install it with:
We upgrade datapane regularly to include new features, both in the client and on the hosted version. From time to time your client may no longer be compatible with the datapane server when uploading a report. If this happens, you will receive an error like the following:
In such an event, please upgrade your datapane cli via
conda and try again.
Upgrading via pip
If you installed datapane via pip, run the following command:
Upgrading via conda
If you installed
datapane via conda, run the following command, adding the
--all flag if needed. As above, if you receive errors please try using a fresh conda environment.
Windows Tips and Troubleshooting
Having problems running on Windows? Please read on...
We generally recommend installing via
pip on Windows as it's easier to install all the required dependencies.
If you need to install Python first, the latest versions of Windows 10 can install Python for you automatically - running
python from the command-prompt will take you to the Windows Store where you can download an official version. We also strongly recommend using a 64-bit rather than the 32-bit version of Python, you can check this by running the command
python -c "import struct; print(struct.calcsize('P')*8, 'bit')" from the Command Prompt.
Also note that on Windows, you can run the
datapane command either by running
datapane.exe on the command-line.
Some specific issues you may encounter on Windows include:
Import errors when running/importing datapane
You may encounter errors such as
ImportError: DLL load failed when running datapane or importing it within your Python code.
If so, try installing the Visual C++ Redistributables for Windows from Microsoft and running again (you most likely want to download the version for x64, i.e.
Datapane install errors trying to compile
pyarrow using Visual C++
This usually occurs when you are running a 32-bit version of Python and installing via
pip. Either try using
conda or install a 64-bit version of Python (for example from the Windows Store as mentioned above).
This may also occur when using Windows 7 - we only support directly Windows 10, however, it may be worth trying to install via
conda instead, if you are stuck on Windows 7.
'datapane.exe' is not recognized as an internal or external command
This occurs when your Windows
%PATH% doesn't include all the Python directories, specifically the
You may notice during the datapane install messages such as (or similar to):
To fix this, adjust your
%PATH% to include your specific
Scripts path as mentioned in the
pip warning (see https://datatofish.com/add-python-to-windows-path/ for more detailed instructions). Alternatively, you can try running the datapane client directly, using the command
python3.exe -m datapane.client instead.