Workflow test, release, badges and cleanup

Author: danielebriggi

.github/workflows/deploy.yaml

@@ -5,7 +5,6 @@ name: Test and Release
 
 on:
   push:
-  pull_request:
   workflow_dispatch:
 
 jobs:
@@ -40,7 +39,11 @@ jobs:
         SQLITE_DB: ${{ vars.SQLITE_DB }}
         SQLITE_PORT: ${{ vars.SQLITE_PORT }}
       run: |
-        pytest -v src/tests
+        pytest --cov -v src/tests
+    - name: Upload coverage reports to Codecov
+      uses: codecov/[email protected]
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
   release:
     if: ${{ github.ref == 'refs/heads/main' }}
     needs: tests

.gitignore

@@ -7,6 +7,7 @@ main.dSYM/
 .env
 *.pyc
 *.pyo
+.coverage
 
 .DS_Store
 

README.md

@@ -1,16 +1,28 @@
 # Python SDK for SQLite Cloud
 
-![Build Status](https://github.com/sqlitecloud/python/actions/workflows/deploy.yaml/badge.svg "Build Status") ![Jupyter Notebook](https://img.shields.io/badge/jupyter-%23FA0F00.svg?style=plastic&logo=jupyter&logoColor=white)
+<p align="center">
+  <img src="https://sqlitecloud.io/social/logo.png" height="300" alt="SQLite Cloud logo">
+</p>
 
-SQLiteCloud is a powerful Python package that allows you to interact with the SQLite Cloud backend server seamlessly. It provides methods for various database operations. This package is designed to simplify database operations in Python applications, making it easier than ever to work with SQLite Cloud.
+![Build Status](https://github.com/sqlitecloud/python/actions/workflows/deploy.yaml/badge.svg "Build Status")
+[![codecov](https://codecov.io/github/sqlitecloud/python/graph/badge.svg?token=38G6FGOWKP)](https://codecov.io/github/sqlitecloud/python)
+![PyPI - Version](https://img.shields.io/pypi/v/sqlitecloud?link=https%3A%2F%2Fpypi.org%2Fproject%2FSqliteCloud%2F)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/sqlitecloud?link=https%3A%2F%2Fpypi.org%2Fproject%2FSqliteCloud%2F)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sqlitecloud?link=https%3A%2F%2Fpypi.org%2Fproject%2FSqliteCloud%2F)
 
 
+[SQLiteCloud](https://sqlitecloud.io) is a powerful Python package that allows you to interact with the SQLite Cloud backend server seamlessly. It provides methods for various database operations. This package is designed to simplify database operations in Python applications, making it easier than ever to work with SQLite Cloud.
+
+- Site: [https://sqlitecloud.io](https://sqlitecloud.io/developers)
+- Documentation: https://..._coming!_
+- Source: [https://github.com/sqlitecloud/python](https://github.com/sqlitecloud/python)
+
 ## Installation
 
 You can install SqliteCloud Package using Python Package Index (PYPI):
 
 ```bash
-$ pip install SqliteCloud
+$ pip install sqlitecloud
 ```
 
 ## Usage
@@ -19,7 +31,6 @@ $ pip install SqliteCloud
 ```python
 from sqlitecloud.client import SqliteCloudClient
 from sqlitecloud.types import SqliteCloudAccount
-
 ```
 
 ### _Init a connection_
@@ -35,7 +46,7 @@ conn = client.open_connection()
 #### _Using string configuration_
 
 ```python
-account = SqliteCloudAccount("sqlitecloud://user:[email protected]:port/dbname?timeout=10&key2=value2&key3=value3")
+account = SqliteCloudAccount("sqlitecloud://user:[email protected]:port/dbname?apikey=myapikey")
 client = SqliteCloudClient(cloud_account=account)
 conn = client.open_connection()
 ```
@@ -56,6 +67,16 @@ for row in result:
     print(row)
 ```
 
+### _Specific value_
+```python
+result.get_value(0, 0)
+```
+
+### _Column name_
+```python
+result.get_name(0)
+```
+
 ### _Close connection_
 
 ```python

requirements-dev.txt

@@ -2,6 +2,8 @@
 typing-extensions==4.1.1
 pytest==7.0.1
 pytest-mock==3.6.1
+pytest-cov==4.0.0
+coverage==6.2
 python-dotenv==0.20.0
 lz4==3.1.10
 bump2version==1.0.1

samples.ipynb

@@ -21,7 +21,6 @@
     "\n",
     "sys.path.append('/workspaces/python/src')\n",
     "\n",
-    "from sqlitecloud.conn_info import user, password, host, db_name, port\n",
     "from sqlitecloud.client import SqliteCloudClient\n",
     "from sqlitecloud.types import SqliteCloudAccount"
    ]
@@ -41,7 +40,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "account = SqliteCloudAccount(user, password, host, db_name, int(port))\n",
+    "account = SqliteCloudAccount(user, password, host, db_name, 8860)\n",
     "client = SqliteCloudClient(cloud_account=account)\n",
     "conn = client.open_connection()"
    ]

src/sqlitecloud/driver.py

@@ -186,12 +186,12 @@ def _internal_pubsub_thread(self, connection: SQCloudConnect) -> None:
                     ready_to_read, _, errors = select.select(
                         [connection.pubsub_socket], [], []
                     )
-                    # eg, no data to read
-                    if len(ready_to_read) == 0:
-                        continue
                     # eg, if the socket is closed
                     if len(errors) > 0:
                         break
+                    # eg, no data to read
+                    if len(ready_to_read) == 0:
+                        continue
 
                     data = connection.pubsub_socket.recv(blen)
                     if not data:

src/tests/integration/test_pubsub.py

@@ -22,6 +22,7 @@ def test_listen_channel_and_notify(self, sqlitecloud_connection):
 
         def assert_callback(conn, result, data):
             nonlocal callback_called
+            nonlocal flag
 
             if isinstance(result, SqliteCloudResultSet):
                 assert result.tag == SQCLOUD_RESULT_TYPE.RESULT_JSON
@@ -107,6 +108,7 @@ def test_set_pubsub_only(self, sqlitecloud_connection):
 
         def assert_callback(conn, result, data):
             nonlocal callback_called
+            nonlocal flag
 
             if isinstance(result, SqliteCloudResultSet):
                 assert result.get_result() is not None
@@ -129,13 +131,13 @@ def assert_callback(conn, result, data):
         pubsub2 = SqliteCloudPubSub()
         pubsub2.notify_channel(connection2, channel, "message-in-a-bottle")
 
+        client.disconnect(connection2)
+
         # wait for callback to be called
         flag.wait(30)
 
         assert callback_called
 
-        client.disconnect(connection2)
-
     def test_listen_table_for_update(self, sqlitecloud_connection):
         connection, client = sqlitecloud_connection
 
@@ -144,6 +146,7 @@ def test_listen_table_for_update(self, sqlitecloud_connection):
 
         def assert_callback(conn, result, data):
             nonlocal callback_called
+            nonlocal flag
 
             if isinstance(result, SqliteCloudResultSet):
                 assert result.tag == SQCLOUD_RESULT_TYPE.RESULT_JSON