Skip to content
This repository has been archived by the owner on Aug 15, 2020. It is now read-only.

mindsdb/mindsdb_server

Repository files navigation

MindsDB

Build status PyPi Version PyPi Downloads MindsDB Community API Docs

Mindsdb Server

This server uses flask_restx to define the API. Check API's docs for detailed information about each endpoint.

Installation

To install mindsdb server from PyPi run:

pip install mindsdb-server

Usage

Once you have the server installed, you can start it by calling the start_server():

import mindsdb_server as server

server.start_server()

Note that mindsdb server by default runs on 47334 port. To change that include port parameter:

server.start_server(port=43773)

Development installation

To install and run mindsdb_server for development, activate your virtualenv and run:

python setup.py develop
pip install -r requirements.txt
cd mindsdb_server
python3 server.py

You can provide basic parameters to the server.py call as:

  • --port, the default is 47334
  • --use_mindsdb_storage_dir, the default is False
  • --host, the default is 0.0.0.0

Example: python3 server.py --port 47333

The code inside mindsdb_server

  • namespaces/<endpoint.py>: these contains a file per API resource
  • namespaces/configs: these are the configs for the API resources
  • namespaces/entitites: these are specs for the document objects that can be returned by the API resources