Metadata-Version: 2.4
Name: aws-s3-cli
Version: 0.0.7
Summary: Upload, download, check file availability, and list files from AWS S3 bucket
Home-page: https://github.com/sujitmandal/aws-s3-cli
Author: Sujit Mandal
Author-email: mandals974@gmail.com
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: boto3>=1.20
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

## aws-s3-cli :
[![Downloads](https://static.pepy.tech/personalized-badge/aws-s3-cli?period=total&units=international_system&left_color=black&right_color=blue&left_text=Downloads)](https://pepy.tech/project/aws-s3-cli)[![GitHub license](https://img.shields.io/github/license/sujitmandal/aws-s3-cli)](https://github.com/sujitmandal/aws-s3-cli/blob/master/LICENSE) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aws-s3-cli) ![PyPI - Wheel](https://img.shields.io/pypi/wheel/aws-s3-cli) ![PyPI](https://img.shields.io/pypi/v/aws-s3-cli) 


```
# aws-s3-cli

Simple AWS S3 helper library.

## Features
- Upload file
- Download file
- Check file availability
- List files
- Presigned GET / PUT / POST URLs

```


## Package Installation : 
```
pip install aws-s3-cli
```
[Pypi Package Link](https://pypi.org/project/aws-s3-cli/)


## How to import the module:
```python
FILE_OBJ = "" # File object
FILE_NAME = "" # File name
S3_FILE_NAME = "" # S3 file name or uploaded file name
BUCKET_NAME = "" # Bucket name
AWS_ACCESS_KEY = "" # Access key ID
AWS_SECRET_ACCESS_KEY = "" # Secret access key
```
## Upload File : 
```python
from aws_s3_cli.aws_s3_cli import upload_file

status = upload_file(BUCKET_NAME, AWS_ACCESS_KEY, AWS_SECRET_ACCESS_KEY, FILE_OBJ, FILE_NAME)

print(status)
```

## Download File : 
```python
from aws_s3_cli.aws_s3_cli import download_file

status = download_file(BUCKET_NAME, AWS_ACCESS_KEY, AWS_SECRET_ACCESS_KEY, S3_FILE_NAME, FILE_NAME)

print(status)
```

## Check File Status : 
```python
from aws_s3_cli.aws_s3_cli import check_file_status

status = check_file_status(BUCKET_NAME, AWS_ACCESS_KEY, AWS_SECRET_ACCESS_KEY, S3_FILE_NAME)

print(status)
```

## Get All File List : 
```python
from aws_s3_cli.aws_s3_cli import get_all_file_list

file_list = get_all_file_list(BUCKET_NAME, AWS_ACCESS_KEY, AWS_SECRET_ACCESS_KEY)

print(file_list)
```

## Get All File Dictionary : 
```python
from aws_s3_cli.aws_s3_cli import get_all_file_dict

file_dict = get_all_file_dict(BUCKET_NAME, AWS_ACCESS_KEY, AWS_SECRET_ACCESS_KEY)

print(file_dict)
```
## Generate Presigned Download URL (GET)
```python
from aws_s3_cli.aws_s3_cli import generate_presigned_url

response = generate_presigned_url(
    BUCKET_NAME,
    AWS_ACCESS_KEY,
    AWS_SECRET_ACCESS_KEY,
    S3_FILE_NAME
)

print(response)
```

## Generate Presigned Upload URL (PUT)
```python
from aws_s3_cli.aws_s3_cli import generate_presigned_upload_url

response = generate_presigned_upload_url(
    BUCKET_NAME,
    AWS_ACCESS_KEY,
    AWS_SECRET_ACCESS_KEY,
    S3_FILE_NAME
)

print(response)
```

## Generate Presigned POST Policy
```python
from aws_s3_cli.aws_s3_cli import generate_presigned_post

response = generate_presigned_post(
    BUCKET_NAME,
    AWS_ACCESS_KEY,
    AWS_SECRET_ACCESS_KEY,
    KEY_PREFIX
)

print(response)
```

## Required package’s:
```
• pip install boto3
```

---

## 6️⃣ `LICENSE` (MIT)

```text
MIT License

Copyright (c) 2024 Sujit Mandal

## Author:
Sujit Mandal

[GitHub](https://github.com/sujitmandal)

[PyPi](https://pypi.org/user/sujitmandal/)

[LinkedIn](https://www.linkedin.com/in/sujit-mandal-91215013a/)
