Merge pull request #62 from mindsdb/staging

Release 1.0.5

Author: ea-rus

CONTRIBUTING.md

@@ -1,8 +1,10 @@
 # Contributing to Mindsdb
 
-We love to receive contributions from the community and hear your opinions! We want to make contributing to Mindsdb as easily as it can be.
+Being part of the core MindsDB team is accessible to anyone who is motivated and wants to be part of that journey!
 
-# How can you help us?
+Please see below how to contribute to the project, also refer to the contributing documentation.
+
+## How can you help us?
 
 * Report a bug
 * Improve documentation
@@ -11,9 +13,9 @@ We love to receive contributions from the community and hear your opinions! We w
 * Propose new features
 * Test Mindsdb
 
-# Code contributions
-In general, we follow the "fork-and-pull" Git workflow.
+## Code contributions
 
+In general, we follow the "fork-and-pull" Git workflow.
 1. Fork the Mindsdb repository
 2. Clone the repository
 3. Make changes and commit them
@@ -22,14 +24,24 @@ In general, we follow the "fork-and-pull" Git workflow.
 6. Write a commit message
 7. Make sure that the CI tests are GREEN
 
->NOTE: Be sure to merge the latest from "upstream" before making a pull request!
+> NOTE: Be sure to merge the latest from "upstream" before making a pull request! Also, make the PR to the staging branch.
+
+## Feature and Bug reports
+We use GitHub issues to track bugs and features. Report them by opening a [new issue](https://github.com/mindsdb/mindsdb_python_sdk/issues/new/choose) and fill out all of the required inputs.
+
+## Code review process
+
+The Pull Request reviews are done on a regular basis. Please, make sure you respond to our feedback/questions.
+
+## Community
+
+If you have additional questions or you want to chat with the MindsDB core team, please join our [Slack community](https://mindsdb.com/joincommunity) or post at [Github Discussions](https://github.com/mindsdb/mindsdb_python_sdk/discussions).
+ 
+To get updates on MindsDB’s latest announcements, releases, and events, sign up for our [Monthly Community Newsletter](https://mindsdb.com/newsletter/?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo).
+
+Join our mission of democratizing machine learning!
 
-# Feature and Bug reports
-We use GitHub issues to track bugs and features. Report them by opening a [new issue](https://github.com/mindsdb/mindsdb/issues/new/choose) and fill out all of the required inputs.
+## Contributor Code of Conduct
 
-# Code review process
-The Pull Request reviews are done on a regular basis. 
-Please, make sure you respond to our feedback/questions.
+Please note that this project is released with a [Contributor Code of Conduct](https://github.com/mindsdb/mindsdb_python_sdk/blob/stable/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
 
-# Community
-If you have additional questions or you want to chat with MindsDB core team, you can join our community [![Discourse posts](https://img.shields.io/discourse/posts?server=https%3A%2F%2Fcommunity.mindsdb.com%2F)](https://community.mindsdb.com/). To get updates on MindsDB’s latest announcements, releases, and events, [sign up for our newsletter](https://mindsdb.us20.list-manage.com/subscribe/post?u=5174706490c4f461e54869879&id=242786942a).

README.md

@@ -1,161 +1,129 @@
 # Python MindsDB SDK
-It enables you to connect to a MindsDB server from python using HTTP API.
 
-## Install
+The Python MindsDB SDK allows you to connect to a MindsDB server from Python using the HTTP API.
+
+## Installation
+
 ```
 pip install mindsdb_sdk
 ```
 
 ## Example
 
-Connect:
-```python
-import mindsdb_sdk
+### Connecting to the MindsDB server
+
+You can establish a connection to the MindsDB server using the SDK. Here are some examples:
 
-# Connect to local server 
+#### Connect to a local MindsDB server
 
+```python
+import mindsdb_sdk
 server = mindsdb_sdk.connect()
 server = mindsdb_sdk.connect('http://127.0.0.1:47334')
+```
 
-# Connect to cloud server
+#### 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='-')
+```
 
-# Connect to MindsDB Pro
+####  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)
-
 ```
 
-Base usage:
-```python
+## Basic usage
 
-# database
+Once connected to the server, you can perform various operations. Here are some examples:
+
+```python
+# Get a list of databases
 databases = server.list_databases()
 
-database = databases[0] # Database type object
+# Get a specific database
+database = databases[0]  # Database type object
 
-# sql query
+# Perform an SQL query
 query = database.query('select * from table1')
 print(query.fetch())
 
-# create table
+# Create a table
 table = database.create_table('table2', query)
 
-
-# project
+# Get a project
 project = server.get_project('proj')
 
-# sql query
+# Perform an SQL query within a project
 query = project.query('select * from database.table join model1')
 
-# create view
-view = project.create_view(
-      'btc_view',
-       query=query
-)
+# Create a view
+view = project.create_view('view1', query=query)
 
-# get view
+# Get a list of views
 views = project.list_views()
 view = views[0]
 df = view.fetch()
 
-# get model
+# Get a list of models
 models = project.list_models()
 model = models[0]
 
-# using model
+# Use a model for prediction
 result_df = model.predict(df)
 result_df = model.predict(query)
 
-# create model
+# Create a model
+timeseries_options = {
+    'order': 'date',
+    'window': 5,
+    'horizon': 1
+}
 model = project.create_model(
-      'rentals_model',
-      predict='price',
-      query=query,
+    'rentals_model',
+    predict='price',
+    query=query,
+    timeseries_options=timeseries_options
 )
 
 ```
 
-More examples in [Google colab notebook](
+You can find more examples in this [Google colab notebook](
 https://colab.research.google.com/drive/1QouwAR3saFb9ffthrIs1LSH5COzyQa11#scrollTo=k6IbwsKRPQCR
 )
 
-## API documentation
-
-Api documentation can be found in: 
-https://mindsdb.github.io/mindsdb_python_sdk/
-
+## API Documentation
 
-**Generating api docs:**
+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:
 
-Locally:
+### Generating API docs locally:
 
 ```commandline
 cd docs
-
 pip install -r requirements.txt
-
 make html
 ```
 
-
-**Online documentation** is updated by pushing in `docs` branch
+The online documentation is automatically updated by pushing changes to the docs branch.
 
 
+## Testing
 
-## How to test
-`
-It runs all tests for components 
+To run all the tests for the components, use the following command:
 
 ```bash
 env PYTHONPATH=./ pytest
 ```
 
-## How to Connect From a Python File
+## Contributing
 
-Create a file in your python project's root directory to store the connection details:
+We welcome contributions to the MindsDB SDK. If you'd like to contribute, please refer to the contribution guidelines for more information.
 
-`server.py` 
+## License
 
-Add the connection arguments with **your MindsDB credentials** to `server.py`:
-
-```python
-import mindsdb_sdk
-
-server = mindsdb_sdk.connect()
-server = mindsdb_sdk.connect('http://127.0.0.1:47334')
-
-server = mindsdb_sdk.connect(email='your_mindsdb_email', password='your_mindsdb_password')
-server = mindsdb_sdk.connect('https://cloud.mindsdb.com', email='your_mindsdb_email', password='your_mindsdb_password')
-```
-
-Open your terminal and type:
-
-`python server.py` 
-
-### Testing the Connection
-
-Add test queries to `server.py` with `print()` statements to confirm the connection:
-
-```python
-import mindsdb_sdk #import the mindsdb_sdk package
-
-server = mindsdb_sdk.connect()
-server = mindsdb_sdk.connect('http://127.0.0.1:47334')
-
-#  Input your MindsDB Cloud Credentials below to connect to MindsDB Cloud
-server = mindsdb_sdk.connect(email='your_mindsdb_email', password='your_mindsdb_password')
-server = mindsdb_sdk.connect('https://cloud.mindsdb.com', email='your_mindsdb_email', password='your_mindsdb_password') # Connect to MindsDB server in the cloud
-
-databases = server.list_databases()
-
-database = databases[1] # Database type object
-
-query = database.query('select * from files.test_data')
-print(database)
-```
+The MindsDB SDK is licensed under the MIT License. Feel free to use and modify it according to your needs
 
-To see a full example, checkout:
-`server.py`

docs/tests/server.py

@@ -1,6 +1,6 @@
 __title__ = 'mindsdb_sdk'
 __package_name__ = 'mindsdb_sdk'
-__version__ = '1.0.4'
+__version__ = '1.0.5'
 __description__ = "MindsDB Python SDK, provides an SDK to use a remote mindsdb instance"
 __email__ = "jorge@mindsdb.com"
 __author__ = 'MindsDB Inc'

mindsdb_sdk/__about__.py

@@ -1,8 +1,10 @@
 from functools import wraps
+import io
 
 import requests
 import pandas as pd
 
+from .. import __about__
 
 def _try_relogin(fnc):
     @wraps(fnc)
@@ -38,6 +40,8 @@ def __init__(self, url=None, login=None, password=None, is_managed=False):
         self.is_managed = is_managed
         self.session = requests.Session()
 
+        self.session.headers['User-Agent'] = f'python-sdk/{__about__.__version__}'
+
         if login is not None:
             self.login()
 
@@ -114,3 +118,25 @@ def objects_tree(self, item=''):
         _raise_for_status(r)
 
         return pd.DataFrame(r.json())
+
+    @_try_relogin
+    def upload_file(self, name: str, df: pd.DataFrame):
+
+        # convert to file
+        fd = io.BytesIO()
+        df.to_csv(fd)
+        fd.seek(0)
+
+        url = self.url + f'/api/files/{name}'
+        r = self.session.put(
+            url,
+            data={
+                'source': name,
+                'name': name,
+                'source_type': 'file',
+            },
+            files={
+                'file': fd,
+            }
+        )
+        _raise_for_status(r)