Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dbcli/athenacli
AthenaCLI is a CLI tool for AWS Athena service that can do auto-completion and syntax highlighting.
https://github.com/dbcli/athenacli
athena-cli autocompletion aws-athena aws-cli bigdata cli command-line python syntax-highlighting
Last synced: 3 days ago
JSON representation
AthenaCLI is a CLI tool for AWS Athena service that can do auto-completion and syntax highlighting.
- Host: GitHub
- URL: https://github.com/dbcli/athenacli
- Owner: dbcli
- License: bsd-3-clause
- Created: 2018-08-23T04:30:53.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2022-05-16T00:50:48.000Z (over 2 years ago)
- Last Synced: 2024-04-26T13:31:45.842Z (7 months ago)
- Topics: athena-cli, autocompletion, aws-athena, aws-cli, bigdata, cli, command-line, python, syntax-highlighting
- Language: Python
- Homepage: https://athenacli.readthedocs.io/
- Size: 995 KB
- Stars: 205
- Watchers: 7
- Forks: 31
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://travis-ci.org/dbcli/athenacli)
[](https://pypi.python.org/pypi/athenacli)
[](https://pepy.tech/project/athenacli)
[](https://pypi.org/project/athenacli/)
[](https://pypi.org/project/athenacli/)
[](https://gitter.im/dbcli/athenacli?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# Introduction
AthenaCLI is a command line interface (CLI) for the [Athena](https://aws.amazon.com/athena/) service that can do auto-completion and syntax highlighting, and is a proud member of the dbcli community.
# Quick Start
## Install
### Install via `pip`
If you already know how to install python packages, then you can simply do:
``` bash
$ pip install athenacli
```
### Install via `brew`
[Homebrew](https://brew.sh/) users can install by:
```sh
$ brew install athenacli
```
If you don't know how to install python packages, please check the [Install](./docs/install.rst) page for more options (e.g docker)
## Config
A config file is automatically created at `~/.athenacli/athenaclirc` at first launch (run athenacli). See the file itself for a description of all available options.
Below 4 variables are required. If you are a user of aws cli, you can refer to [awsconfig](./docs/awsconfig.rst) file to see how to reuse credentials configuration of aws cli.
``` text
# AWS credentials
aws_access_key_id = ''
aws_secret_access_key = ''
region = '' # e.g us-west-2, us-east-1
# Amazon S3 staging directory where query results are stored.
# NOTE: S3 should in the same region as specified above.
# The format is 's3://'
s3_staging_dir = ''
# Name of athena workgroup that you want to use
work_group = '' # e.g. primary
```
or you can also use environment variables:
``` bash
$ export AWS_ACCESS_KEY_ID=YOUR_ACCESS_KEY_ID
$ export AWS_SECRET_ACCESS_KEY=YOUR_SECRET_ACCESS_KEY
$ export AWS_DEFAULT_REGION=us-west-2
$ export AWS_ATHENA_S3_STAGING_DIR=s3://YOUR_S3_BUCKET/path/to/
$ export AWS_ATHENA_WORK_GROUP=YOUR_ATHENA_WORK_GROUP
```
## Create a table
``` bash
$ athenacli -e examples/create_table.sql
```
You can find `examples/create_table.sql` [here](./examples/create_table.sql).
## Run a query
``` bash
$ athenacli -e 'select elb_name, request_ip from elb_logs LIMIT 10'
```
## REPL
``` bash
$ athenacli []
```
# Features
- Auto-completes as you type for SQL keywords as well as tables and columns in the database.
- Syntax highlighting.
- Smart-completion will suggest context-sensitive completion.
- `SELECT * FROM ` will only show table names.
- `SELECT * FROM users WHERE ` will only show column names.
- Pretty prints tabular data and various table formats.
- Some special commands. e.g. Favorite queries.
- Alias support. Column completions will work even when table names are aliased.
Please refer to the [Features](./docs/features.rst) page for the screenshots of above features.
# Usages
```bash
$ athenacli --help
Usage: main.py [OPTIONS] [DATABASE]
A Athena terminal client with auto-completion and syntax highlighting.
Examples:
- athenacli
- athenacli my_database
Options:
-e, --execute TEXT Execute a command (or a file) and quit.
-r, --region TEXT AWS region.
--aws-access-key-id TEXT AWS access key id.
--aws-secret-access-key TEXT AWS secretaccess key.
--s3-staging-dir TEXT Amazon S3 staging directory where query
results are stored.
--work-group TEXT Amazon Athena workgroup in which query is run, default is primary
--athenaclirc PATH Location of athenaclirc file.
--help Show this message and exit.
```
Please go to the [Usages](https://athenacli.readthedocs.io/en/latest/usage.html) for detailed information on how to use AthenaCLI.
# Contributions
If you're interested in contributing to this project, first of all I would like to extend my heartfelt gratitude. I've written a small [doc](https://athenacli.readthedocs.io/en/latest/develop.html) to describe how to get this running in a development setup.
Please feel free to reach out to me if you need help. My email: zhuzhaolong0 AT gmail com
# FAQs
Please refer to the [FAQs](https://athenacli.readthedocs.io/en/latest/faq.html) for other information, e.g. "How can I get support for athenacli?".
# Credits
A special thanks to [Amjith Ramanujam](https://github.com/amjith) for creating pgcli and mycli, which inspired me to create this AthenaCLI, and AthenaCLI is created based on a clone of mycli.
Thanks to [Jonathan Slenders](https://github.com/jonathanslenders) for creating the [Python Prompt Toolkit](https://github.com/jonathanslenders/python-prompt-toolkit), which leads me to pgcli and mycli. It's a lot of fun playing with this library.
Thanks to [PyAthena](https://github.com/laughingman7743/PyAthena) for a pure python adapter to Athena database.
Last but not least, thanks my team and manager encourage me to work on this hobby project.
# Similar projects
- [satterly/athena-cli](https://github.com/satterly/athena-cli): Presto-like CLI tool for AWS Athena.
- [pengwynn/athena-cli](https://github.com/pengwynn/athena-cli): CLI for Amazon Athena, powered by JRuby.