Skip to content

Commit a560bb1

Browse files
Convert README from reStructuredText to Markdown
Use HTML <p align="center"> for logo centering which GitHub renders correctly, unlike RST's :align: center directive. Update pyproject.toml readme and sdist references accordingly. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 51ac398 commit a560bb1

File tree

3 files changed

+65
-113
lines changed

3 files changed

+65
-113
lines changed

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<p align="center">
2+
<img src="docs/_static/logo.png" alt="PyAthena logo" width="200">
3+
</p>
4+
5+
# PyAthena
6+
7+
PyAthena is a Python [DB API 2.0 (PEP 249)](https://www.python.org/dev/peps/pep-0249/) client for [Amazon Athena](https://docs.aws.amazon.com/athena/latest/APIReference/Welcome.html).
8+
9+
| | |
10+
|---------|------------------------------------------------|
11+
| Package | [![PyPI Version](https://badge.fury.io/py/pyathena.svg)](https://badge.fury.io/py/pyathena) [![Python Versions](https://img.shields.io/pypi/pyversions/PyAthena.svg)](https://pypi.org/project/PyAthena/) [![Downloads](https://static.pepy.tech/badge/pyathena/month)](https://pepy.tech/project/pyathena) |
12+
| CI/CD | [![Test](https://github.com/laughingman7743/PyAthena/actions/workflows/test.yaml/badge.svg)](https://github.com/laughingman7743/PyAthena/actions/workflows/test.yaml) [![Docs](https://github.com/laughingman7743/PyAthena/actions/workflows/docs.yaml/badge.svg)](https://github.com/laughingman7743/PyAthena/actions/workflows/docs.yaml) |
13+
| Meta | [![License](https://img.shields.io/pypi/l/PyAthena.svg)](https://github.com/laughingman7743/PyAthena/blob/master/LICENSE) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/) |
14+
15+
## Requirements
16+
17+
* Python
18+
19+
- CPython 3.10, 3.11, 3.12, 3.13, 3.14
20+
21+
## Installation
22+
23+
```bash
24+
$ pip install PyAthena
25+
```
26+
27+
Extra packages:
28+
29+
| Package | Install command | Version |
30+
|------------|--------------------------------------|----------|
31+
| SQLAlchemy | `pip install PyAthena[SQLAlchemy]` | >=1.0.0 |
32+
| Pandas | `pip install PyAthena[Pandas]` | >=1.3.0 |
33+
| Arrow | `pip install PyAthena[Arrow]` | >=10.0.0 |
34+
| Polars | `pip install PyAthena[Polars]` | >=1.0.0 |
35+
36+
## Usage
37+
38+
```python
39+
from pyathena import connect
40+
41+
cursor = connect(s3_staging_dir="s3://YOUR_S3_BUCKET/path/to/",
42+
region_name="us-west-2").cursor()
43+
cursor.execute("SELECT * FROM one_row")
44+
print(cursor.description)
45+
print(cursor.fetchall())
46+
```
47+
48+
## License
49+
50+
[MIT license](LICENSE)
51+
52+
Many of the implementations in this library are based on [PyHive](https://github.com/dropbox/PyHive), thanks for [PyHive](https://github.com/dropbox/PyHive).
53+
54+
## Links
55+
56+
- Documentation: https://laughingman7743.github.io/PyAthena/
57+
- PyPI Releases: https://pypi.org/project/PyAthena/
58+
- Source Code: https://github.com/laughingman7743/PyAthena/
59+
- Issue Tracker: https://github.com/laughingman7743/PyAthena/issues
60+
61+
## Logo
62+
63+
The PyAthena logo was generated using [Nano-Banana Pro](https://deepmind.google/models/gemini-image/pro/) (Gemini 3 Pro Image).

README.rst

Lines changed: 0 additions & 111 deletions
This file was deleted.

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ dependencies = [
1212
"python-dateutil",
1313
]
1414
requires-python = ">=3.10"
15-
readme = "README.rst"
15+
readme = "README.md"
1616
license = {file = "LICENSE"}
1717
classifiers = [
1818
"Development Status :: 4 - Beta",
@@ -90,7 +90,7 @@ only-include = [
9090
"pyathena/",
9191
"LICENSE",
9292
"pyproject.toml",
93-
"README.rst"
93+
"README.md"
9494
]
9595

9696
[tool.hatch.build.targets.wheel]

0 commit comments

Comments
 (0)