Skip to content

installation.mdx

Latest commit

 

History

History
40 lines (27 loc) · 1.05 KB

installation.mdx

File metadata and controls

40 lines (27 loc) · 1.05 KB
title Installation
sidebarTitle Installation

Python SDK enables you to connect to the MindsDB server from Python using HTTP API. Read along to see how to install and test the MindsDB Python SDK.

Simple Installation

To install the MindsDB Python SDK, run the below command:

pip install mindsdb_sdk

Here is the expected output:

Advanced Installation

Instead of using the pip install mindsdb_sdk command, you can install it by cloning the Python SDK repository. Then you should create a virtual environment, install all dependencies from the requirements.txt file, and run tests as instructed below.

To test all the components, go to the project directory (mindsdb_sdk) and run the below command:

env PYTHONPATH=./ pytest

To generate the API documentation, run the below commands:

pip install sphinx
cd docs
make html

The documentation is generated in the docs/build/html folder.