Package: pyqldb
Amazon QLDB Python DriverThis is the Python driver forAmazon Quantum Ledger Database (QLDB), which allows Python developers
to write software that makes use of Amazon QLDB.For getting started with the driver, seePython and Amazon QLDB.RequirementsBasic ConfigurationSeeAccessing Amazon QLDBfor information on connecting to AWS.Required Python versionsPyqldb 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 InstallationGetting StartedPlease see theQuickstart guide for the Amazon QLDB Driver for Python.First, install the driver using pip:pip install pyqldbThen from a Python interpreter, call the driver and specify the ledger name:frompyqldb.driver.qldb_driverimportQldbDriverqldb_driver=QldbDriver(ledger_name='test-ledger')fortableinqldb_driver.list_tables():print(table)See AlsoGetting Started with Amazon QLDB Python DriverA guide that gets you started with executing transactions with the QLDB Python driver.QLDB Python Driver CookbookThe cookbook provides code samples for some simple QLDB Python driver use cases.Amazon QLDB Python Driver Tutorial: In this tutorial, you use the QLDB Driver for Python to create an Amazon QLDB ledger and populate it with tables and sample data.Amazon QLDB Python Driver Samples: A DMV based example application which demonstrates how to use QLDB with the QLDB Driver for Python.QLDB Python driver accepts and returnsAmazon IONDocuments. Amazon Ion is a richly-typed, self-describing, hierarchical data serialization format offering interchangeable binary and text representations. For more information read theION docs.Amazon QLDB supports thePartiQLquery language. PartiQL provides SQL-compatible query access across multiple data stores containing structured data, semistructured data, and nested data. For more information read thePartiQL docs.Refer the sectionCommon Errors while using the Amazon QLDB Driverswhich describes runtime errors that can be thrown by the Amazon QLDB Driver when calling the qldb-session APIs.DevelopmentSetupAssuming that you have Python andvirtualenvinstalled, set up your environment and installed the dependencies
like this instead of thepip install pyqldbdefined 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 TestsYou can run the unit tests with this command:$ pytest --cov-report term-missing --cov=pyqldb tests/unitYou can run the integration tests with this command:$ pytest tests/integrationDocumentationSphinx is used for documentation. You can generate HTML locally with the following:$ pip install -r requirements-docs.txt
$ pip install -e .
$ cd docs
$ make htmlGetting HelpPlease use these community resources for getting help.Ask a question on StackOverflow and tag it with theamazon-qldbtag.Open a support ticket withAWS Support.Make a new thread atAWS QLDB Forum.If you think you may have found a bug, please open anissue.Opening IssuesIf you encounter a bug with the Amazon QLDB Python Driver, we would like to hear about it. Please search theexisting issuesand see if others are also experiencing the issue before opening a new issue. When opening a new issue, we will need the version of Amazon QLDB Python Driver, Python language version, and OS you're using. Please also include reproduction case for the issue when appropriate.The GitHub issues are intended for bug reports and feature requests. For help and questions with using Amazon QLDB Python Driver, please make use of the resources listed in theGetting Helpsection. Keeping the list of open issues lean will help us respond in a timely manner.LicenseThis library is licensed under the Apache 2.0 License.