Skip to main content

Upload, download, check file availability, and list files from AWS S3 bucket

Project description

aws-s3-cli :

DownloadsGitHub license PyPI - Python Version PyPI - Wheel PyPI

# 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

How to import the module:

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 :

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 :

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 :

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 :

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 :

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)

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)

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

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)

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/)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aws_s3_cli-0.0.7.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aws_s3_cli-0.0.7-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file aws_s3_cli-0.0.7.tar.gz.

File metadata

  • Download URL: aws_s3_cli-0.0.7.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.9

File hashes

Hashes for aws_s3_cli-0.0.7.tar.gz
Algorithm Hash digest
SHA256 66429ff2b1e020e67783057bfe841c508dbfb303dd31180dab0c7ec5c2dbff00
MD5 1c184de059faa28031c386a4992c1fbe
BLAKE2b-256 766497570863713866771331d4c1e931bcb7d7a5c1685b8b10401ceab4ca8bf8

See more details on using hashes here.

File details

Details for the file aws_s3_cli-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: aws_s3_cli-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.9

File hashes

Hashes for aws_s3_cli-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 a6fc2e036df3b0d039e5d7dbf66826f227285ca2f599205064b8952d81a5d7d6
MD5 9b280662c77314014e57990be704f2d0
BLAKE2b-256 ed020c059fa15aa51ff04980aa9901a18e784b6b9e455998390e6308ed981d8a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page