Metadata-Version: 2.1
Name: rdsdataapi
Version: 0.1.0
Summary: DBAPI 2.0 adapter & SqlAlchemy Dialect for the RDS Data API
Home-page: https://github.com/dschep/rdsdataapi
Author: Daniel Schep
Author-email: dschep@gmail.com
License: MIT
Description: 
        # DB-API 2.0 driver & SqlAlchemy dialect for the AWS RDS Data API
        
        **NOTE: This is currently ALPHA quality software and has not been thoroughly tested yet**
        
        The RDS Data API allows use of MySQL and PostgreSQL RDS databases via an HTTP API, making it ideal
        for use in AWS Lambda because it allow syou to use RDS without running your lambda in a VPC. This
        library wraps that API in both a [DB-API 2.0](https://www.python.org/dev/peps/pep-0249/) driver and
        [SqlAlchemy](https://www.sqlalchemy.org/) dialect allowing you to tap into the vast python
        ecosystem for working with relational databases.
        
        
        ## Installation
        ```
        pip install rdsdataapi
        ```
        
        
        ## Usage
        
        To use the DB-API 2.0 interface:
        ```python
        from rdsdataapi import connect
        con = connect(
            resource_arn="arn:aws:rds:us-east-1:490103061721:cluster:database-1",
            secret_arn="arn:aws:secretsmanager:us-east-1:490103061721:secret:database-PI9BfJ",
            database="mysql",
        )
        cur = con.cursor()
        cur.execute("select :foo as bar", {"foo": "foobar"})
        result = cur.fetchall()
        ```
        
        Or via SqlAlchemy:
        ```python
        engine = create_engine(
            'rdsdataapi://',
            connect_args=dict(
                secret_arn="arn:aws:secretsmanager:us-east-1:490103061721:secret:database-PI9BfJ",
                resource_arn="arn:aws:rds:us-east-1:490103061721:cluster:database-1",
                database="mysql"
            )
        )
        with engine.connect() as con:
            result = con.execute("select :foo as bar", foo="foobar")
        ```
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Database
Classifier: Topic :: Database :: Front-Ends
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
Provides-Extra: sqlalchemy
