Docs

Author: Richard O'Dwyer

Diff for: README.md

@@ -1,2 +1,102 @@
 # sheet2api-python
-Google/Excel Sheets API Python
+
+Google/Excel Sheets API Python Client. For use with https://sheet.com/
+
+## Installation
+
+```bash
+pip install sheet2api
+```
+
+## Usage Examples
+
+Before we can do anything we need to create an instance of the API client.
+
+```python
+from sheet2api import SheetAPIClient
+
+client = SheetAPIClient(api_url='https://sheet2api.com/v1/FgI6zV8qT222/my-api/')
+# If your API has authentication enabled
+client = SheetAPIClient(
+    api_url='https://sheet2api.com/v1/FgI6zV8qT222/my-api/',
+    username='api_username_here', password='api_password_here'
+)
+```
+
+### Get all rows
+
+Returns all rows within the **first** Sheet of your Spreadsheet.
+
+```python
+client.get_rows()
+
+# Returns a list of dicts
+[{
+	'name': 'Bob',
+	'age': 22
+}, {
+	'name': 'Richard',
+	'age': 19
+}, {
+	'name': 'Bob Jones',
+	'age': 99
+}]
+```
+
+To return rows from a specific Sheet.
+
+
+```python
+client.get_rows(sheet='Sheet1')
+```
+
+### Get all rows matching a query
+
+Returns all rows matching a query.
+
+```python
+client.get_rows(query={'name': 'Bob'})
+```
+
+
+### Create a new row
+
+```python
+client.create_row(sheet='Sheet1', row={'name': 'Jane','age': 18,})
+```
+
+### Update all rows which match a query
+
+This will update the entire row for the matches, if you fail to specificy all column values in the replacement `row`, those cells will be filled with an empty value.
+
+```python
+client.update_rows(
+    sheet='Sheet1,
+    query={'name': 'Philip'},
+    row={
+        'name': 'Phil',
+        'age': 99999
+    },
+)
+```
+
+Partially update rows matching a query.
+
+This will only update the columns which you provide replacement values for in the `row` dict parameter. All other columns will be left unchanged.
+
+```python
+client.update_rows(
+    sheet='Sheet1,
+    query={'name': 'Philip'},
+    row={
+        'age': 99999
+    },
+)
+```
+
+
+### Delete all rows matching a query
+
+```python
+client.delete_rows(sheet='Sheet1', query={'name': 'Satan'})
+```

Diff for: sheet2api/client.py

@@ -13,7 +13,7 @@ def __init__(self, *, api_url, username=None, password=None):
         if username:
             self._auth = HTTPBasicAuth(username, password)
 
-    def read_rows(self, *, sheet=None, query=None):
+    def get_rows(self, *, sheet=None, query=None):
         url = self._url(sheet=sheet)
         logger.info('Reading rows from sheet %s within %s...', sheet, url)
         resp = self._request('get', url, params=query)

Diff for: tests/tests.py

@@ -30,7 +30,7 @@ class TestReadRows:
     def test_returns_all_rows_in_spreadsheet(self, client_fixture, request):
         client = request.getfixturevalue(client_fixture)
 
-        rows = client.read_rows()
+        rows = client.get_rows()
 
         assert rows == [{
             'name': 'Bob',
@@ -44,7 +44,7 @@ def test_returns_all_rows_in_spreadsheet(self, client_fixture, request):
         }]
 
     def test_returns_all_rows_for_a_specific_sheet(self, client):
-        rows = client.read_rows(sheet='Address')
+        rows = client.get_rows(sheet='Address')
 
         assert rows == [{
             'name': 'Bob',
@@ -55,7 +55,7 @@ def test_returns_all_rows_for_a_specific_sheet(self, client):
         }]
 
     def test_returns_filtered_rows_when_query_is_passed(self, client):
-        rows = client.read_rows(query={'name': 'Bob'})
+        rows = client.get_rows(query={'name': 'Bob'})
 
         assert rows == [{'name': 'Bob', 'age': 22}]
 
@@ -77,7 +77,7 @@ def fin():
         added_row = client.create_row(sheet=sheet, row=row)
 
         assert added_row == row
-        assert client.read_rows(sheet=sheet) == [row] + [{
+        assert client.get_rows(sheet=sheet) == [row] + [{
             'name': 'Bob',
             'age': 22
         }, {
@@ -114,7 +114,7 @@ def fin():
         )
 
         assert updates_made == [{'name': name, 'age': 99999}]
-        assert client.read_rows(sheet=sheet) == [{
+        assert client.get_rows(sheet=sheet) == [{
             'name': name,
             'age': 99999
         }, {
@@ -152,7 +152,7 @@ def fin():
         )
 
         assert updates_made == [{'name': name}]
-        assert client.read_rows(sheet=sheet) == [{
+        assert client.get_rows(sheet=sheet) == [{
             'name': name,
             'age': 18
         }, {