This server uses flask_restx to define the API. Check API's docs for detailed information about each endpoint.
To install mindsdb server from PyPi run:
pip install mindsdb-server
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)
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
namespaces/<endpoint.py>
: these contains a file per API resourcenamespaces/configs
: these are the configs for the API resourcesnamespaces/entitites
: these are specs for the document objects that can be returned by the API resources