Skip to content

Commit c75670e

Browse files
Add project logo to README and documentation
Add PyAthena logo (owl with Athena helmet and Python snake) generated with Nano-Banana Pro (Gemini 3 Pro Image). The logo is displayed in the Furo theme sidebar for documentation and at the top of the README. - Add transparent PNG logo to docs/_static/logo.png - Add logo image and Nano-Banana Pro attribution to README.rst - Configure html_logo in docs/conf.py for Furo sidebar display - Add custom CSS for sidebar logo styling Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 9d65171 commit c75670e

File tree

6 files changed

+70
-103
lines changed

6 files changed

+70
-103
lines changed

README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# PyAthena
2+
3+
<div align="center">
4+
5+
<img src="docs/_static/icon.png" alt="PyAthena logo" width="200">
6+
7+
| | |
8+
| --- | --- |
9+
| Package | [![PyPI - Version](https://badge.fury.io/py/pyathena.svg)](https://badge.fury.io/py/pyathena) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/PyAthena.svg)](https://pypi.org/project/PyAthena/) [![PyPI - Downloads](https://static.pepy.tech/badge/pyathena/month)](https://pepy.tech/project/pyathena) |
10+
| CI/CD | [![CI - Test](https://github.com/laughingman7743/PyAthena/actions/workflows/test.yaml/badge.svg)](https://github.com/laughingman7743/PyAthena/actions/workflows/test.yaml) [![CD - Docs](https://github.com/laughingman7743/PyAthena/actions/workflows/docs.yaml/badge.svg)](https://github.com/laughingman7743/PyAthena/actions/workflows/docs.yaml) |
11+
| Meta | [![License - MIT](https://img.shields.io/pypi/l/PyAthena.svg)](https://github.com/laughingman7743/PyAthena/blob/master/LICENSE) [![linting - 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) [![types - Mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/) |
12+
13+
</div>
14+
15+
-----
16+
17+
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).
18+
19+
## Requirements
20+
21+
* Python
22+
23+
- CPython 3.10, 3.11, 3.12, 3.13, 3.14
24+
25+
## Installation
26+
27+
```bash
28+
$ pip install PyAthena
29+
```
30+
31+
Extra packages:
32+
33+
| Package | Install command | Version |
34+
|------------|--------------------------------------|----------|
35+
| SQLAlchemy | `pip install PyAthena[SQLAlchemy]` | >=1.0.0 |
36+
| Pandas | `pip install PyAthena[Pandas]` | >=1.3.0 |
37+
| Arrow | `pip install PyAthena[Arrow]` | >=10.0.0 |
38+
| Polars | `pip install PyAthena[Polars]` | >=1.0.0 |
39+
40+
## Usage
41+
42+
```python
43+
from pyathena import connect
44+
45+
cursor = connect(s3_staging_dir="s3://YOUR_S3_BUCKET/path/to/",
46+
region_name="us-west-2").cursor()
47+
cursor.execute("SELECT * FROM one_row")
48+
print(cursor.description)
49+
print(cursor.fetchall())
50+
```
51+
52+
## License
53+
54+
[MIT license](LICENSE)
55+
56+
Many of the implementations in this library are based on [PyHive](https://github.com/dropbox/PyHive), thanks for [PyHive](https://github.com/dropbox/PyHive).
57+
58+
## Links
59+
60+
- Documentation: https://laughingman7743.github.io/PyAthena/
61+
- PyPI Releases: https://pypi.org/project/PyAthena/
62+
- Source Code: https://github.com/laughingman7743/PyAthena/
63+
- Issue Tracker: https://github.com/laughingman7743/PyAthena/issues
64+
65+
## Logo
66+
67+
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 & 101 deletions
This file was deleted.

docs/_static/icon.png

2.95 MB
Loading

docs/_static/icon_with_text.png

3.3 MB
Loading

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,7 @@ def setup(app):
162162
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
163163

164164
html_theme = "furo"
165+
html_logo = "_static/icon.png"
165166
html_static_path = ["_static"]
166167
html_css_files = [
167168
"custom.css",

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)