couchbeans 0.0.1__tar.gz

couchbeans-0.0.1/.gitignore

@@ -0,0 +1,171 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc

couchbeans-0.0.1/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

couchbeans-0.0.1/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.2
+Name: couchbeans
+Version: 0.0.1
+Summary: A CouchDB library for python, focused on network resilience.
+Author-email: Alex Baldwin <contact@alexbaldwin.dev>
+License: LGPL-3.0
+Project-URL: Homepage, https://github.com/owoalex/couchbeans
+Project-URL: Issues, https://github.com/owoalex/couchbeans/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.4
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+
+# CouchBeans
+*Have you ever held up a broken couch with a tin of beans?* CouchBeans is a [CouchDB](https://couchdb.apache.org/) library for python, aiming to provide as much resilience as possible for dodgy network environments. It's designed to be quick and easy to use, with as much complexity hidden from the user as possible.
+
+A quick example:
+```
+>>> from couchbeans import CouchClient
+>>> db = CouchClient("http://root:couchbeans@localhost:6984/")
+>>> db.get_document("main", "bb0065e5-d047-4bfc-b64a-855adeb89e35")
+{"_id":"bb0065e5-d047-4bfc-b64a-855adeb89e35", "_rev": "1-90d3dbcd053542fda4bdd6754ecc917a", "msg": "hello world!"}
+```
+
+Have a look at the [test script](./test/example.py) for more examples of how to use CouchBeans.
+
+## Installation
+CouchBeans is installable via PIP:
+```pip install couchbeans```
+
+## Features
+The main advantage of CouchBeans over other CouchDB libraries is its default handling of failed requests. CouchBeans will try a user-configurable number of times to execute a request to help with spotty network connections.
+
+CouchBeans provides utility functions for modifying documents, including a patch operation. It also hides handling of the _rev parameter, making it easy to forget about the underlying network connections.
+
+## Dependencies
+
+- requests

couchbeans-0.0.1/README.md

@@ -0,0 +1,25 @@
+# CouchBeans
+*Have you ever held up a broken couch with a tin of beans?* CouchBeans is a [CouchDB](https://couchdb.apache.org/) library for python, aiming to provide as much resilience as possible for dodgy network environments. It's designed to be quick and easy to use, with as much complexity hidden from the user as possible.
+
+A quick example:
+```
+>>> from couchbeans import CouchClient
+>>> db = CouchClient("http://root:couchbeans@localhost:6984/")
+>>> db.get_document("main", "bb0065e5-d047-4bfc-b64a-855adeb89e35")
+{"_id":"bb0065e5-d047-4bfc-b64a-855adeb89e35", "_rev": "1-90d3dbcd053542fda4bdd6754ecc917a", "msg": "hello world!"}
+```
+
+Have a look at the [test script](./test/example.py) for more examples of how to use CouchBeans.
+
+## Installation
+CouchBeans is installable via PIP:
+```pip install couchbeans```
+
+## Features
+The main advantage of CouchBeans over other CouchDB libraries is its default handling of failed requests. CouchBeans will try a user-configurable number of times to execute a request to help with spotty network connections.
+
+CouchBeans provides utility functions for modifying documents, including a patch operation. It also hides handling of the _rev parameter, making it easy to forget about the underlying network connections.
+
+## Dependencies
+
+- requests

couchbeans-0.0.1/pyproject.toml

@@ -0,0 +1,33 @@
+[project]
+name = "couchbeans"
+dynamic = ["version"]
+authors = [
+  { name="Alex Baldwin", email="contact@alexbaldwin.dev" },
+]
+license = { text="LGPL-3.0" }
+description = "A CouchDB library for python, focused on network resilience."
+readme = "README.md"
+requires-python = ">=3.4"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "requests >= 2.28.0"
+]
+
+[project.urls]
+Homepage = "https://github.com/owoalex/couchbeans"
+Issues = "https://github.com/owoalex/couchbeans/issues"
+
+[tool.setuptools.dynamic]
+
+[tool.setuptools]
+packages = ["couchbeans"]
+package-dir = {"" = "src"}
+
+[tool.setuptools_scm]
+
+[build-system]
+requires = ["setuptools>=64", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"

couchbeans-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

couchbeans-0.0.1/src/couchbeans/__init__.py

@@ -0,0 +1,3 @@
+
+from .client import CouchClient, HTTPMethod
+

couchbeans-0.0.1/src/couchbeans/client.py

@@ -0,0 +1,116 @@
+import requests
+from enum import Enum
+from .exceptions import *
+
+class HTTPMethod(Enum):
+    GET = 1
+    POST = 2
+    PUT = 3
+    DELETE = 4
+
+class CouchClient:
+    __max_retries = 3
+    __connection_timeout = 3000
+    __verbose = False
+
+    def __init__(self, couch_base_uri):
+        if couch_base_uri.endswith("/"):
+            couch_base_uri = couch_base_uri[:-1]
+        self.__couch_base_uri = couch_base_uri
+        self.__current_session = requests.Session()
+
+    def get_server_version(self):
+        response = self.__couch_query("/", HTTPMethod.GET)
+        if "version" in response:
+            return response["version"]
+        return None
+
+    def set_verbose(self, verbose=True):
+        self.__verbose = verbose
+
+    def set_timeout(self, timeout):
+        self.__connection_timeout = timeout
+
+    def set_max_retries(self, max_retries):
+        self.__max_retries = max_retries
+
+    def __couch_query(self, endpoint, method, args = None):
+        try_n = 0
+        while try_n < self.__max_retries:
+            try:
+                if method == HTTPMethod.POST:
+                    response = self.__current_session.post(self.__couch_base_uri + endpoint, json=args, timeout=self.__connection_timeout)
+                elif method == HTTPMethod.DELETE:
+                    response = self.__current_session.delete(self.__couch_base_uri + endpoint, timeout=self.__connection_timeout)
+                elif method == HTTPMethod.PUT:
+                    response = self.__current_session.put(self.__couch_base_uri + endpoint, json=args, timeout=self.__connection_timeout)
+                else:
+                    response = self.__current_session.get(self.__couch_base_uri + endpoint, timeout=self.__connection_timeout)
+                if response.status_code >= 200 and response.status_code < 300:
+                    return response.json()
+                else:
+                    raise CouchHTTPError(response.json(), response.status_code)
+            except requests.exceptions.ConnectionError:
+                if self.__verbose:
+                    print("Request (" + endpoint + ") was refused on try " + str(try_n))
+                try_n += 1
+            except requests.exceptions.Timeout:
+                if self.__verbose:
+                    print("Request (" + endpoint + ") timed out on try " + str(try_n))
+                try_n += 1
+        raise ConnectionError("Gave up connecting to CouchDB after " + str(try_n) + " tries")
+
+    def find(self, database, selector = [], fields = None, sort = None, page = 0, page_size = 20):
+        for sortby in sort:
+            for key in sortby:
+                if not key in selector:
+                    selector[key] = {"$exists": True}
+        mango = {
+                "selector": selector,
+                "skip": page * page_size,
+                "limit": page_size
+            }
+
+        if not sort is None:
+            mango["sort"] = sort
+
+        if not fields is None:
+            mango["fields"] = fields
+
+        return self.__couch_query("/" + database + "/_find", HTTPMethod.POST, mango)
+
+    def create_db(self, database, shards=None, replicas=None, partitioned=False):
+        options = {
+                "partitioned": bool(partitioned)
+            }
+        if not shards is None:
+            options["q"] = int(shards)
+        if not replicas is None:
+            options["n"] = int(replicas)
+        try:
+            self.__couch_query("/" + database, HTTPMethod.PUT, options)
+            return True
+        except CouchHTTPError as e:
+            if e.code == 412:
+                raise ObjectAlreadyExistsException("Database already exists", database)
+            raise e
+
+    def delete_db(self, database):
+        return self.__couch_query("/" + database, HTTPMethod.DELETE)
+
+    def get_document(self, database, doc_id):
+        return self.__couch_query("/" + database + "/" + str(doc_id), HTTPMethod.GET)
+
+    # This is a utility function - it will just delete whatever is at the ID!
+    def delete_document(self, database, doc_id):
+        document = self.__couch_query("/" + database + "/" + str(doc_id), HTTPMethod.GET)
+        return self.__couch_query("/" + database + "/" + str(doc_id) + "?rev=" + document["_rev"], HTTPMethod.DELETE)
+
+    def put_document(self, database, doc_id, document):
+        return self.__couch_query("/" + database + "/" + str(doc_id), HTTPMethod.PUT, document)
+
+    # Another utility function, will modify the document regardless of _rev
+    def patch_document(self, database, doc_id, document_diff):
+        document = self.__couch_query("/" + database + "/" + str(doc_id), HTTPMethod.GET)
+        merged_document = {**document, **document_diff}
+        return self.__couch_query("/" + database + "/" + str(doc_id), HTTPMethod.PUT, merged_document)

couchbeans-0.0.1/src/couchbeans/exceptions.py

@@ -0,0 +1,17 @@
+import json
+
+class CouchHTTPError(Exception):
+    def __init__(self, body, code):
+        self.body = body
+        self.code = code
+
+    def __str__(self):
+        return "Error " + str(self.code) + " returned from CouchDB: " + json.dumps(self.body)
+
+class ObjectAlreadyExistsException(Exception):
+    def __init__(self, message, obj_id):
+        self.message = message
+        self.obj_id = obj_id
+
+    def __str__(self):
+        return self.message

couchbeans-0.0.1/src/couchbeans.egg-info/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.2
+Name: couchbeans
+Version: 0.0.1
+Summary: A CouchDB library for python, focused on network resilience.
+Author-email: Alex Baldwin <contact@alexbaldwin.dev>
+License: LGPL-3.0
+Project-URL: Homepage, https://github.com/owoalex/couchbeans
+Project-URL: Issues, https://github.com/owoalex/couchbeans/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.4
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+
+# CouchBeans
+*Have you ever held up a broken couch with a tin of beans?* CouchBeans is a [CouchDB](https://couchdb.apache.org/) library for python, aiming to provide as much resilience as possible for dodgy network environments. It's designed to be quick and easy to use, with as much complexity hidden from the user as possible.
+
+A quick example:
+```
+>>> from couchbeans import CouchClient
+>>> db = CouchClient("http://root:couchbeans@localhost:6984/")
+>>> db.get_document("main", "bb0065e5-d047-4bfc-b64a-855adeb89e35")
+{"_id":"bb0065e5-d047-4bfc-b64a-855adeb89e35", "_rev": "1-90d3dbcd053542fda4bdd6754ecc917a", "msg": "hello world!"}
+```
+
+Have a look at the [test script](./test/example.py) for more examples of how to use CouchBeans.
+
+## Installation
+CouchBeans is installable via PIP:
+```pip install couchbeans```
+
+## Features
+The main advantage of CouchBeans over other CouchDB libraries is its default handling of failed requests. CouchBeans will try a user-configurable number of times to execute a request to help with spotty network connections.
+
+CouchBeans provides utility functions for modifying documents, including a patch operation. It also hides handling of the _rev parameter, making it easy to forget about the underlying network connections.
+
+## Dependencies
+
+- requests

couchbeans-0.0.1/src/couchbeans.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+.gitignore
+LICENSE
+README.md
+pyproject.toml
+src/couchbeans/__init__.py
+src/couchbeans/client.py
+src/couchbeans/exceptions.py
+src/couchbeans.egg-info/PKG-INFO
+src/couchbeans.egg-info/SOURCES.txt
+src/couchbeans.egg-info/dependency_links.txt
+src/couchbeans.egg-info/requires.txt
+src/couchbeans.egg-info/top_level.txt
+test/couchbeans
+test/example.py

couchbeans-0.0.1/src/couchbeans.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

couchbeans-0.0.1/src/couchbeans.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.28.0

couchbeans-0.0.1/src/couchbeans.egg-info/top_level.txt

@@ -0,0 +1 @@
+couchbeans

couchbeans-0.0.1/test/example.py

@@ -0,0 +1,141 @@
+#!/bin/python3
+
+from couchbeans import CouchClient
+from couchbeans.exceptions import ObjectAlreadyExistsException
+import argparse
+import json
+
+def get_doc_diff(doc1, doc2):
+    if "_rev" in doc1: # These are very likely to be different, but not useful for most unit tests
+        del doc1["_rev"]
+    if "_rev" in doc2:
+        del doc2["_rev"]
+    if "_id" in doc1: # Also not that useful for testing
+        del doc1["_id"]
+    if "_id" in doc2:
+        del doc2["_id"]
+    set1 = set(doc1.items())
+    set2 = set(doc2.items())
+    diff = set2 ^ set1
+    return diff
+
+def test_base_connection(conn, verbose):
+    if verbose:
+        print("Testing base connection")
+    if len(conn.get_server_version()) > 3:
+        return True
+    return False
+
+def test_create_db(conn, verbose):
+    if verbose:
+        print("Testing db creation")
+    if conn.create_db("beans_test_db"):
+        return True
+    return False
+
+def test_delete_db(conn, verbose):
+    if verbose:
+        print("Testing db deletion")
+    if conn.delete_db("beans_test_db"):
+        return True
+    return False
+
+def test_put_document(conn, verbose):
+    if verbose:
+        print("Testing creating a document")
+    desired_doc = {
+            "edible": True,
+            "price": 1.20,
+            "weight": 500,
+            "stock": 256
+        }
+    conn.put_document("beans_test_db", "baked", desired_doc)
+    doc = conn.get_document("beans_test_db", "baked")
+    #print(json.dumps(doc, indent=4))
+    return len(get_doc_diff(doc, desired_doc)) == 0 # Check for an exact match
+
+def test_patch_document(conn, verbose):
+    if verbose:
+        print("Testing patching the last document")
+    desired_doc = {
+            "edible": True,
+            "price": 1.20,
+            "weight": 500,
+            "stock": 255
+        } # This should be the state of the doc after the patch
+    patch = {
+            "stock": 255 # Someone's eaten some beans!
+        }
+    conn.patch_document("beans_test_db", "baked", patch)
+    doc = conn.get_document("beans_test_db", "baked")
+    #print(json.dumps(doc, indent=4))
+    return len(get_doc_diff(doc, desired_doc)) == 0 # Check for an exact match
+
+def test_delete_document(conn, verbose):
+    if verbose:
+        print("Testing deleting the last document")
+    conn.delete_document("beans_test_db", "baked")
+    return True
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+                    prog="CouchBeans tester",
+                    description="Tests the CouchBeans library, and acts as an example program")
+
+    parser.add_argument("connection_uri")
+    parser.add_argument("-v", "--verbose", action="store_true")
+    parser.add_argument("-j", "--json", action="store_true")
+
+    args = parser.parse_args()
+
+
+    as_json = args.json
+    verbose = args.verbose
+    if as_json:
+        verbose = False
+    couch_base_uri = args.connection_uri # e.g. http://root:couchbeans@localhost:5984/
+    conn = CouchClient(couch_base_uri)
+    conn.set_verbose(verbose)
+
+    passed_tests = []
+    failed_tests = []
+    exceptions = []
+    tests = [
+            test_base_connection,
+            test_create_db,
+            test_put_document,
+            test_patch_document,
+            test_delete_document,
+            test_delete_db,
+        ]
+
+    for test in tests:
+        try:
+            if test(conn, verbose):
+                passed_tests.append(test.__name__)
+            else:
+                failed_tests.append(test.__name__)
+        except Exception as e:
+            exceptions.append({
+                    "on": test.__name__,
+                    "error": str(e)
+                })
+
+    if as_json:
+        output = {
+                "passed": passed_tests,
+                "failed": failed_tests,
+                "crashed": exceptions
+            }
+        print(json.dumps(output, indent=4))
+    else:
+        print(f"{len(passed_tests)} tests passed")
+        for passt in passed_tests:
+            print("    - " + passt)
+        print(f"{len(failed_tests)} tests failed")
+        for failt in failed_tests:
+            print("    - " + failt)
+        print(f"{len(exceptions)} exceptions:")
+        for exception in exceptions:
+            print("    - " + exception["test"])
+            print("      " + exception["exception"])