py-data-api is a user-friendly client for AWS Aurora Serverless's Data API
Project description
py-data-api - Data API Client for Python
py-data-api is a client for Data API of Aurora Serverless. Also, the package includes SQLAlchemy Dialects and DB API 2.0 Client.
Features
- SQLAlchemy Dialects
- DB API 2.0 compatible client PEP 249
Support Database Engines
- MySQL
- PostgreSQL
What's AWS Aurora Serverless's Data API?
https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
This project is an experimental phase.
Warning: Some interface will be changed.
How to install
pydataapi requires Python 3.6.1 or later
$ pip install pydataapi
Example
from typing import List
from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base
from pydataapi import DataAPI, Result
class Pets(declarative_base()):
__tablename__ = 'pets'
id = Column(Integer, primary_key=True, autoincrement=True)
name = Column(String(255, collation='utf8_unicode_ci'), default=None)
database: str = 'test'
resource_arn: str = 'arn:aws:rds:us-east-1:123456789012:cluster:serverless-test-1'
secret_arn: str = 'arn:aws:secretsmanager:us-east-1:123456789012:secret:serverless-test1'
def example_driver_for_sqlalchemy():
from sqlalchemy.engine import create_engine
engine = create_engine(
'mysql+pydataapi://',
connect_args={
'resource_arn': 'arn:aws:rds:us-east-1:123456789012:cluster:dummy',
'secret_arn': 'arn:aws:secretsmanager:us-east-1:123456789012:secret:dummy',
'database': 'test'}
)
result = engine.execute("select * from pets")
print(result.fetchall())
def example_simple_execute():
data_api = DataAPI(resource_arn=resource_arn, secret_arn=secret_arn, database=database)
result: Result = data_api.execute('show tables')
print(result.scalar())
# Pets
Contributing to pydataapi
We are waiting for your contributions to pydataapi.
How to contribute
https://koxudaxi.github.io/py-data-api/contributing
Related projects
local-data-api
DataAPI Server for local
https://github.com/koxudaxi/local-data-api
PyPi
https://pypi.org/project/pydataapi
Source Code
https://github.com/koxudaxi/py-data-api
Documentation
https://koxudaxi.github.io/py-data-api
License
py-data-api is released under the MIT License. http://www.opensource.org/licenses/mit-license
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pydataapi-0.4.24-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b4d122db2e0977ea66a7f23b3b446ab9d629157172b6c234649bc07d4d80f64a |
|
| MD5 | 895709f2fd16ed66d8c4a1022222abcb |
|
| BLAKE2b-256 | aadfc696ae6f92cf9cd133bc5ceb1c9f18fee6b5ba96513e72261597b85e7ff5 |
