Metadata-Version: 2.1
Name: pythena
Version: 0.1.1
Summary: A simple athena wrapper leveraging boto3 to execute queries and return results while only requiring a database and a query string.
Home-page: https://github.com/chrispruitt/pythena
Author: chris.pruitt
Author-email: chris.pruitt15@gmail.com
License: Mozilla Public License Version 2.0
Description: # pythena
        
        This is a simple python module that will allow you to query athena the same way the AWS Athena console would. It only requires a database name and query string.
        
        ## Install
        ```bash
        pip install pythena
        ```
        
        ## Setup
        Be sure to set up your AWS authentication credentials. You can do so by using the aws cli and running
        ```
        pip install awscli
        aws configure
        ```
        More help on configuring the aws cli here https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html
        
        
        
        ## Usage
        
        ```python
        import pythena
        
        # Returns results as a pandas dataframe
        df = pythena.execute(database="mydatabase", query="select * from mytable")
        
        print(df.sample(n=2)) # Prints 2 rows from your dataframe
        ```
        
        Specify an s3 url to save results to a bucket.
        ```python
        import pythena
        
        # Returns results as a pandas dataframe
        df = pythena.execute(database="mydatabase", 
                            query="select * from mytable", 
                            s3_output_url="s3://mybucket/mydir")
        
        print(df.sample(n=2)) # Prints 2 rows from your dataframe
        ```
        
        ## Note
        By default, when executing athena queries, via boto3 or the AWS athena console, the results are saved in an s3 bucket. This module by default, assuming a successful execution, will delete the s3 result file to keep s3 clean. If an s3_output_url is provided, it the result file will not be deleted.
Platform: UNKNOWN
Description-Content-Type: text/markdown
