Merge pull request #73 from mindsdb/staging

Release 2.0.0

Author: ea-rus

.github/workflows/mindsdb_python_sdk.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python-version: [3.7,3.8]
+        python-version: [3.7,3.8,3.9]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}
@@ -39,6 +39,32 @@ jobs:
         CLOUD_TEST_EMAIL: ${{ secrets.CLOUD_TEST_EMAIL }}
         CLOUD_TEST_PASSWORD: ${{ secrets.CLOUD_TEST_PASSWORD }}
 
+  coverage:
+    needs: test
+    if: github.ref != 'refs/heads/stable'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 pytest pytest-cov
+          pip install -r requirements.txt
+
+      - name: Build coverage file
+        run: |
+          pytest --junitxml=pytest.xml --cov-report=term-missing:skip-covered --cov=mindsdb_sdk tests/ | tee pytest-coverage.txt
+
+      - name: Pytest coverage comment
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-coverage-path: ./pytest-coverage.txt
+          junitxml-path: ./pytest.xml
 
   deploy:
     runs-on: ubuntu-latest

README.md

@@ -18,23 +18,23 @@ You can establish a connection to the MindsDB server using the SDK. Here are som
 
 ```python
 import mindsdb_sdk
-server = mindsdb_sdk.connect()
-server = mindsdb_sdk.connect('http://127.0.0.1:47334')
+con = mindsdb_sdk.connect()
+con = mindsdb_sdk.connect('http://127.0.0.1:47334')
 ```
 
 #### Connect to the MindsDB Cloud
 
 ```python
 import mindsdb_sdk
-server = mindsdb_sdk.connect(email='a@b.com', password='-')
-server = mindsdb_sdk.connect('https://cloud.mindsdb.com', login='a@b.com', password='-')
+con = mindsdb_sdk.connect(login='a@b.com', password='-')
+con = mindsdb_sdk.connect('https://cloud.mindsdb.com', login='a@b.com', password='-')
 ```
 
 ####  Connect to a MindsDB Pro server
 
 ```python
 import mindsdb_sdk
-server = mindsdb_sdk.connect('http://<YOUR_INSTANCE_IP>', login='a@b.com', password='-', is_managed=True)
+con = mindsdb_sdk.connect('http://<YOUR_INSTANCE_IP>', login='a@b.com', password='-', is_managed=True)
 ```
 
 ## Basic usage
@@ -43,7 +43,7 @@ Once connected to the server, you can perform various operations. Here are some
 
 ```python
 # Get a list of databases
-databases = server.list_databases()
+databases = con.databases.list()
 
 # Get a specific database
 database = databases[0]  # Database type object
@@ -53,24 +53,27 @@ query = database.query('select * from table1')
 print(query.fetch())
 
 # Create a table
-table = database.create_table('table2', query)
+table = database.tables.create('table2', query)
 
 # Get a project
-project = server.get_project('proj')
+project = con.projects.proj
+
+# or use mindsdb project
+project = con
 
 # Perform an SQL query within a project
 query = project.query('select * from database.table join model1')
 
 # Create a view
-view = project.create_view('view1', query=query)
+view = project.views.create('view1', query=query)
 
 # Get a list of views
-views = project.list_views()
+views = project.views.list()
 view = views[0]
 df = view.fetch()
 
 # Get a list of models
-models = project.list_models()
+models = project.models.list()
 model = models[0]
 
 # Use a model for prediction
@@ -83,19 +86,25 @@ timeseries_options = {
     'window': 5,
     'horizon': 1
 }
-model = project.create_model(
+model = project.models.create(
     'rentals_model',
     predict='price',
     query=query,
     timeseries_options=timeseries_options
 )
 
+# Describe a model
+model.describe()
 ```
 
 You can find more examples in this [Google colab notebook](
 https://colab.research.google.com/drive/1QouwAR3saFb9ffthrIs1LSH5COzyQa11#scrollTo=k6IbwsKRPQCR
 )
 
+## Examples
+
+https://github.com/mindsdb/mindsdb_python_sdk/tree/staging/examples
+
 ## API Documentation
 
 The API documentation for the MindsDB SDK can be found at https://mindsdb.github.io/mindsdb_python_sdk/. You can generate the API documentation locally by following these steps:

docs/requirements.txt

@@ -1,6 +1,6 @@
 requests
-pandas == 1.3.5
-mindsdb-sql >= 0.5.0, < 0.6.0
+pandas >= 1.3.5
+mindsdb-sql >= 0.7.0, < 0.8.0
 
 sphinx
 sphinx-rtd-theme

docs/source/database.rst

@@ -1,7 +1,7 @@
-Database
+Databases
 ----------------------------
 
-.. automodule:: mindsdb_sdk.database
+.. automodule:: mindsdb_sdk.databases
    :members:
    :undoc-members:
    :show-inheritance:

docs/source/handlers.rst

@@ -0,0 +1,7 @@
+Handlers
+-------------------------
+
+.. automodule:: mindsdb_sdk.handlers
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/index.rst

@@ -87,7 +87,12 @@ Base usage
           query=query,
     )
 
+    More
 
+More examples
+-----------
+
+`<https://github.com/mindsdb/mindsdb_python_sdk/examples>`_
 
 API documentation
 =================
@@ -105,9 +110,15 @@ API documentation
 
    server
    database
+   handlers
+   ml_engines
    project
    model
+   tables
+   views
    query
+   jobs
+
 
 Indices and tables
 ------------------

docs/source/jobs.rst

@@ -0,0 +1,7 @@
+Jobs
+-------------------------
+
+.. automodule:: mindsdb_sdk.jobs
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/ml_engines.rst

@@ -0,0 +1,7 @@
+ML Engines
+-------------------------
+
+.. automodule:: mindsdb_sdk.ml_engines
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/model.rst

@@ -1,7 +1,7 @@
-Model
+Models
 -------------------------
 
-.. automodule:: mindsdb_sdk.model
+.. automodule:: mindsdb_sdk.models
    :members:
    :undoc-members:
    :show-inheritance:

docs/source/project.rst

@@ -1,7 +1,7 @@
-Project
+Projects
 ---------------------------
 
-.. automodule:: mindsdb_sdk.project
+.. automodule:: mindsdb_sdk.projects
    :members:
    :undoc-members:
    :show-inheritance: