Metadata-Version: 2.1
Name: pyqldb
Version: 3.0.0rc1
Summary: Python driver for Amazon QLDB
Home-page: UNKNOWN
Author: Amazon Web Services
License: Apache License 2.0
Description: # Amazon QLDB Python Driver
        
        This is the Python driver for [Amazon Quantum Ledger Database (QLDB)](https://aws.amazon.com/qldb/), which allows Python developers
        to write software that makes use of AmazonQLDB.
        
        [![Latest Version](https://img.shields.io/pypi/v/pyqldb.svg)](https://pypi.python.org/pypi/pyqldb)
        [![Documentation Status](https://readthedocs.org/projects/amazon-qldb-driver-python/badge/?version=latest)](https://amazon-qldb-driver-python.readthedocs.io/en/latest/?badge=latest)
        
        For our tutorial, see [Python and Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started.python.html).
        
        ## Requirements
        
        ### Basic Configuration
        
        See [Accessing Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/accessing.html) for information on connecting to AWS.
        
        ### Required Python versions
        
        Pyqldb 2.x requires Python 3.4 or later.
        
        Pyqldb 3.x requires Python 3.6 or later. 
        
        Please see the link below for more detail to install Python:
        
        * [Python Installation](https://www.python.org/downloads/)
        
        ## Getting Started
        
        First, install the driver using pip:
        
        ```pip install pyqldb```
        
        
        Then from a Python interpreter, call the driver and specify the ledger name:
        
        ```python
        from pyqldb.driver.qldb_driver import QldbDriver
        
        qldb_driver = QldbDriver(ledger_name='test-ledger')
        
        for table in qldb_driver.list_tables():
            print(table)
        ```
        
        ### See Also
        
        1. [Getting Started with Amazon QLDB Python Driver](https://amazon-qldb-driver-python.readthedocs.io/en/stable/guide/getting_started.html) A guide that gets you started with executing transactions with the QLDB Python driver.
        2. [QLDB Python Driver Cookbook](https://amazon-qldb-driver-python.readthedocs.io/en/stable/guide/cookbook.html) The cookbook provides code samples for some simple QLDB Python driver use cases. 
        3. [Amazon QLDB Python Driver Tutorial](https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started.python.tutorial.html): In this tutorial, you use the QLDB Driver for Python to create an Amazon QLDB ledger and populate it with tables and sample data.
        4. [Amazon QLDB Python Driver Samples](https://github.com/aws-samples/amazon-qldb-dmv-sample-python): A DMV based example application which demonstrates how to use QLDB with the QLDB Driver for Python.
        5. QLDB Python driver accepts and returns [Amazon ION](http://amzn.github.io/ion-docs/) Documents. Amazon Ion is a richly-typed, self-describing, hierarchical data serialization format offering interchangeable binary and text representations. For more information read the [ION docs](https://readthedocs.org/projects/ion-python/).
        6. Amazon QLDB supports the [PartiQL](https://partiql.org/) query language. PartiQL provides SQL-compatible query access across multiple data stores containing structured data, semistructured data, and nested data. For more information read the [PartiQL docs](https://partiql.org/docs.html).
        7. Refer the section [Common Errors while using the Amazon QLDB Drivers](https://docs.aws.amazon.com/qldb/latest/developerguide/driver-errors.html) which describes runtime errors that can be thrown by the Amazon QLDB Driver when calling the qldb-session APIs.
        
        ## Development
        
        ### Setup
        
        Assuming that you have Python and `virtualenv` installed, set up your environment and installed the dependencies
        like this instead of the `pip install pyqldb` defined above:
        
        ```
        $ git clone https://github.com/awslabs/amazon-qldb-driver-python
        $ cd amazon-qldb-driver-python
        $ virtualenv venv
        ...
        $ . venv/bin/activate
        $ pip install -r requirements.txt
        $ pip install -e .
        ```
        
        ### Running Tests
        
        You can run the unit tests with this command:
        
        ```
        $ pytest --cov-report term-missing --cov=pyqldb tests/unit
        ```
        
        You can run the integration tests with this command:
        ```
        $ pytest tests/integration
        ```
        ### Documentation 
        
        Sphinx is used for documentation. You can generate HTML locally with the following:
        
        ```
        $ pip install -r requirements-docs.txt
        $ pip install -e .
        $ cd docs
        $ make html
        ```
        
        ## License
        
        This library is licensed under the Apache 2.0 License.
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
