Metadata-Version: 2.1
Name: pyboto
Version: 0.1.3
Summary: A simple boto3 wrapper to complete common operations in S3 such as get or put csv files, list objects and keys, etc.
Home-page: https://github.com/steven-purcell/pyboto
Author: steven-purcell
Author-email: steven.ray.purcell@gmail.com
License: Mozilla Public License Version 2.0
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE

# pyboto
Wrapper for commonly used boto3 when working with data stored in AWS S3.

## Install

## 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

## Simple Usage
```
import pyboto

boto_obj = pyboto.Boto('us-east-1')
result = boto_obj.get_keys('myBucket', 'myKeyPrefix')
print(result)

df = boto_obj.get_csv_as_df('myBucket', 'myKey', sep=',')
```

## Full Usage
```
boto_obj.get_keys('myBucket', 'myKeyPrefix')

boto_obj.get_csv_as_df('myBucket', 'myKey', sep=',', skiprows: int, encoding: str, dtype, column_name)

boto_obj.get_file('myBucket', 'myKey')

boto_obj.get_excel('myBucket', 'myKey', engine: str)

boto_obj.put_df('myBucket', 'myKey', pandas_dataframe, header: bool, index: bool, sep=',')

boto_obj.put_file(bucket='myBucket', key='myKey', file_or_buffer=contents)

boto_obj.put_excel('myBucket', 'myKey', pandas_dataframe, header: bool, index: bool):
```

## Note

