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
• Packages:
  • Requests >= 2.19
  • Arrow >= 0.13
• CovenantSQL Adapter Server:
  • CovenantSQL >= 0.0.3

Installation

Package is uploaded on PyPI.

You can install it with pip:

$ python3 -m pip install PyCovenantSQL

Documentation

Documentation is available online: http://developers.covenantsql.io/

Key file and dsn can get from: http://developers.covenantsql.io/docs/quickstart

For support, please fire a issue at Github.

Example

The following examples make use of a simple table

CREATETABLE `users` (
`id`INTEGERPRIMARY KEY AUTOINCREMENT,
`email`varchar(255) NOT NULL,
`password`varchar(255) NOT NULL
);

importpycovenantsql# Connect to the database with dsn# host and port are your local CovenantSQL Adapter serverconnection=pycovenantsql.connect(
dsn='covenantsql://your_database_id',
host='localhost',
port=11108,
)
try:
withconnection.cursor() ascursor:
# Create a new recordsql="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()withconnection.cursor() ascursor:
# Read a single recordsql="SELECT `id`, `password` FROM `users` WHERE `email`=%s"cursor.execute(sql, ('webmaster@python.org',))
result=cursor.fetchone()
print(result)
finally:
connection.close()

This example will print:

{'password': 'very-secret', 'id': 1}

Resources

• DB-API 2.0: http://www.python.org/dev/peps/pep-0249
• CovenantSQL Website: https://covenantsql.io/
• CovenantSQL testnet quick start: https://testnet.covenantsql.io/quickstart
• CovenantSQL source code: https://github.com/CovenantSQL/CovenantSQL

License

PyCovenantSQL is released under the Apache 2.0 License. See LICENSE for more information.