Skip to content
This repository has been archived by the owner on Jun 23, 2024. It is now read-only.

Commit

Permalink
Merge pull request #1 from quiver/update-docs
Browse files Browse the repository at this point in the history
update docs
  • Loading branch information
quiver authored Jan 26, 2018
2 parents dc1bf04 + 21a12c6 commit c87d70a
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 15 deletions.
36 changes: 21 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,26 @@
# athena-dl
CLI to query to Amazon Athena and save its results

# Usage
This package provides a command line interface to query SQL to Amazon Athena and save its results.

The package works on Python versions:

- 2.7.x and greater

# Installation

## install via pip
```
$ pip install athena-dl
```
## install from GitHub

```
$ git clone https://github.com/quiver/athena-dl.git
$ cd athena-dl
$ pip install --editable .
```

# Getting Started

First create SQL files to query against Amazon athena.

Expand Down Expand Up @@ -45,16 +64,3 @@ bar.sql.log # AWS API response for bar.sql
```


# Installation

## install via pip
```
$ pip install athena-dl
```
## install from GitHub

```
$ git clone https://github.com/quiver/athena-dl.git
$ cd athena-dl
$ pip install --editable .
```
8 changes: 8 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,19 @@
setup(
name='Athena-DL',
version='0.1',
description='CLI to ',
author='George Yoshida',
url='https://github.com/quiver/athena-dl',
py_modules=['athena'],
install_requires=[
'Click',
'retry',
],
classifiers=(
'Development Status :: 3 - Alpha',
'License :: OSI Approved :: MIT License'
'Programming Language :: Python :: 2.7',
),
entry_points='''
[console_scripts]
athena-dl=athena_dl:cli
Expand Down

0 comments on commit c87d70a

Please sign in to comment.