Name		Name	Last commit message	Last commit date
pycovenantsql		pycovenantsql
.gitignore		.gitignore
LICENSE		LICENSE
Pipfile		Pipfile
README.rst		README.rst
benchmark.py		benchmark.py
example.py		example.py
runtests.py		runtests.py
setup.py		setup.py

Repository files navigation

PyCovenantSQL

Table of Contents

Requirements
Installation
Documentation
Example
Resources
License

This package contains a pure-Python CovenantSQL client library, based on PEP 249.

NOTE: PyCovenantSQL only support high level APIs defined in PEP 249.

Requirements

Python -- one of the following:
- CPython : 2.7 and >= 3.4
- PyPy : Latest version
HTTP Client:
- Requests >= 2.19
CovenantSQL Proxy Server:
- CovenantSQL >= 0.0.2

Installation

Package is uploaded on PyPI.

You can install it with pip:

$ python3 -m pip install PyCovenantSQL

Documentation

Documentation is available online: https://PyCovenantSQL.readthedocs.io/

Key file and database_id can get from: https://testnet.covenantsql.io/quickstart

For support, please refer to the StackOverflow.

Example

The following examples make use of a simple table

CREATE TABLE `users` (
    `id` INTEGER PRIMARY KEY AUTOINCREMENT,
    `email` varchar(255) NOT NULL,
    `password` varchar(255) NOT NULL
);

import pycovenantsql.cursors

# user key file location
key = '/path/to/private.key'

# Connect to the database
connection = pycovenantsql.connect(host='localhost',
                             port=11108,
                             key=key,
                             database='database_id'
                             )

try:
    with connection.cursor() as cursor:
        # Create a new record
        sql = "INSERT INTO `users` (`email`, `password`) VALUES (%s, %s)"
        cursor.execute(sql, ('webmaster@python.org', 'very-secret'))

    # connection is autocommit. No need to commit in any case.
    # connection.commit()

    with connection.cursor() as cursor:
        # Read a single record
        sql = "SELECT `id`, `password` FROM `users` WHERE `email`=%s"
        cursor.execute(sql, ('webmaster@python.org',))
        result = cursor.fetchone()
        print(result)
finally:
    connection.close()