Metadata-Version: 2.1
Name: mindsdb-server
Version: 1.9.1
Summary: MindsDB server, provides server capabilities to mindsdb native python library
Home-page: https://github.com/mindsdb/mindsdb_server
Author: MindsDB Inc
Author-email: jorge@mindsdb.com
License: MIT
Download-URL: https://pypi.org/project/mindsdb-server/
Description: <h1 align="center">
        	<img width="300" src="https://github.com/mindsdb/mindsdb/blob/master/assets/MindsDBColorPurp@3x.png?raw=true" alt="MindsDB"> 
        	<br>
        	
        </h1>
        
        <p align="center">
            <a href="https://travis-ci.org/mindsdb/mindsdb_server"><img src="https://travis-ci.org/mindsdb/mindsdb_server.svg?branch=master" alt="Build status"></a>
           <a href="https://pypi.org/project/mindsdb-server/"><img src="https://badge.fury.io/py/mindsdb-server.svg" alt="PyPi Version"></a>
          <a href="https://pypi.org/project/mindsdb-server/"><img src="https://img.shields.io/pypi/dm/mindsdb-server" alt="PyPi Downloads"></a>
          <a href="https://community.mindsdb.com/"><img src="https://img.shields.io/discourse/posts?server=https%3A%2F%2Fcommunity.mindsdb.com%2F" alt="MindsDB Community"></a>
          <a href="https://apidocs.mindsdb.com/?version=latest"><img src="https://img.shields.io/badge/API-Documentation-green" alt="API Docs"></a>
        </p>
        
        # Mindsdb Server
        
        This server uses flask_restx to define the API. Check [API's docs](https://apidocs.mindsdb.com/?version=latest) 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
        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
         
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
