lnxpy / mindsdb_python_sdk

The Python SDK for MindsDB Server

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Python MindsDB SDK

It enables you to connect to a MindsDB server from python using HTTP API.

Install

pip install mindsdb_sdk

Example

Connect:

import mindsdb_sdk

# Connect to local server 

server = mindsdb_sdk.connect()
server = mindsdb_sdk.connect('http://127.0.0.1:47334')

# Connect to cloud server

server = mindsdb_sdk.connect(email='a@b.com', password='-')
server = mindsdb_sdk.connect('https://cloud.mindsdb.com', login='a@b.com', password='-')

# Connect to MindsDB Pro

server = mindsdb_sdk.connect('http://<YOUR_INSTANCE_IP>', login='a@b.com', password='-', is_managed=True)

Base usage:

# database
databases = server.list_databases()

database = databases[0] # Database type object

# sql query
query = database.query('select * from table1')
print(query.fetch())

# create table
table = database.create_table('table2', query)


# project
project = server.get_project('proj')

# sql query
query = project.query('select * from database.table join model1')

# create view
view = project.create_view(
      'view1',
       query=query
)

# get view
views = project.list_views()
view = views[0]
df = view.fetch()

# get model
models = project.list_models()
model = models[0]

# using model
result_df = model.predict(df)
result_df = model.predict(query)

# create model
model = project.create_model(
      'rentals_model',
      predict='price',
      query=query,
)

More examples in Google colab notebook

API documentation

Api documentation can be found in: https://mindsdb.github.io/mindsdb_python_sdk/

Generating api docs:

Locally:

cd docs

pip install -r requirements.txt

make html

Online documentation is updated by pushing in docs branch

How to test

It runs all tests for components

env PYTHONPATH=./ pytest

About

The Python SDK for MindsDB Server

License:GNU General Public License v3.0


Languages

Language:Python 100.0%