search

laughingman7743 / PyAthena

PyAthena is a Python DB API 2.0 (PEP 249) client for Amazon Athena.
MIT License
457 stars 102 forks source link
athena aws dbapi python sqlalchemy

readme

.. |badge package| image:: https://badge.fury.io/py/pyathena.svg :target: https://badge.fury.io/py/pyathena .. |badge pypi| image:: https://img.shields.io/pypi/pyversions/PyAthena.svg :target: https://pypi.org/project/PyAthena/ .. |badge test| image:: https://github.com/laughingman7743/PyAthena/actions/workflows/test.yaml/badge.svg :target: https://github.com/laughingman7743/PyAthena/actions/workflows/test.yaml .. |badge docs| image:: https://github.com/laughingman7743/PyAthena/actions/workflows/docs.yaml/badge.svg :target: https://github.com/laughingman7743/PyAthena/actions/workflows/docs.yaml .. |badge license| image:: https://img.shields.io/pypi/l/PyAthena.svg :target: https://github.com/laughingman7743/PyAthena/blob/master/LICENSE .. |badge downloads| image:: https://static.pepy.tech/badge/pyathena/month :target: https://pepy.tech/project/pyathena .. |badge ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json :target: https://github.com/astral-sh/ruff :alt: Ruff .. |badge mypy| image:: https://www.mypy-lang.org/static/mypy_badge.svg :target: https://mypy-lang.org/ :alt: mypy

PyAthena

PyAthena is a Python DB API 2.0 (PEP 249) client for Amazon Athena.

+---------+------------------------------------------------+ | Package | |badge package| |badge pypi| |badge downloads| | +---------+------------------------------------------------+ | CI/CD | |badge test| |badge docs| | +---------+------------------------------------------------+ | Meta | |badge license| |badge ruff| |badge mypy| | +---------+------------------------------------------------+

.. DB API 2.0 (PEP 249): https://www.python.org/dev/peps/pep-0249/ .. Amazon Athena: https://docs.aws.amazon.com/athena/latest/APIReference/Welcome.html

.. _requirements:

Requirements

.. _installation:

Installation

.. code:: bash

$ pip install PyAthena

Extra packages:

+---------------+---------------------------------------+------------------+ | Package | Install command | Version | +===============+=======================================+==================+ | SQLAlchemy | pip install PyAthena[SQLAlchemy] | >=1.0.0 | +---------------+---------------------------------------+------------------+ | Pandas | pip install PyAthena[Pandas] | >=1.3.0 | +---------------+---------------------------------------+------------------+ | Arrow | pip install PyAthena[Arrow] | >=7.0.0 | +---------------+---------------------------------------+------------------+ | fastparquet | pip install PyAthena[fastparquet] | >=0.4.0 | +---------------+---------------------------------------+------------------+

.. _usage:

Usage

.. code:: python

from pyathena import connect

cursor = connect(s3_staging_dir="s3://YOUR_S3_BUCKET/path/to/",
                 region_name="us-west-2").cursor()
cursor.execute("SELECT * FROM one_row")
print(cursor.description)
print(cursor.fetchall())

.. _license:

License

MIT license_

Many of the implementations in this library are based on PyHive, thanks for PyHive.

.. MIT license: LICENSE .. PyHive: https://github.com/dropbox/PyHive

Links