Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/laughingman7743/pyathena

PyAthena is a Python DB API 2.0 (PEP 249) client for Amazon Athena.
https://github.com/laughingman7743/pyathena

athena aws dbapi python sqlalchemy

Last synced: 6 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/laughingman7743/pyathena
Owner: laughingman7743
License: mit
Created: 2017-05-20T23:05:31.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-12-10T14:21:23.000Z (13 days ago)
Last Synced: 2024-12-17T15:06:48.667Z (6 days ago)
Topics: athena, aws, dbapi, python, sqlalchemy
Language: Python
Homepage:
Size: 2.35 MB
Stars: 466
Watchers: 7
Forks: 105
Open Issues: 22
Metadata Files:
- Readme: README.rst
- License: LICENSE

Awesome Lists containing this project

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

------------

* Python

  - CPython 3.9 3.10, 3.11 3.12 3.13

.. _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

-----

- Documentation: https://laughingman7743.github.io/PyAthena/

- PyPI Releases: https://pypi.org/project/PyAthena/

- Source Code: https://github.com/laughingman7743/PyAthena/

- Issue Tracker: https://github.com/laughingman7743/PyAthena/issues