S3Url is a helper class that can help with simple operations on AWS S3 objects
Project description
Overview
S3Url is a helper class that can help with simple operations on AWS S3 objects.
Installation
Get from https://pypi.org/project/s3-url-helper/
e.g pip install s3-url-helper
Usage
from s3_url import S3Url
file_url = S3Url(f's3://test-bucket/prefix/file.json')
# url component properties
assert file_url.bucket == 'test-bucket'
assert file_url.key == 'prefix/file.json'
# factory methods
file_url = S3Url.from_url('s3://test-bucket/prefix/file.json')
file_url = S3Url.from_bucket_key(bucket='test-bucket', key='prefix/file.json')
# access underlying boto3 s3 resource object
boto3_obj = file_url.object
# return url string
url_str: str = file_url.url
url_str: str = str(file_url)
assert url_str == 's3://test-bucket/prefix/file.json'
# check if file exists
exists: bool = file_url.exists()
assert exists
# check if any files exist in prefix (url should end with /)
prefix_exists = S3Url('s3://test-bucket/prefix/').prefix_exists()
assert prefix_exists
# read text/json
file_content: str = file_url.read_text()
file_content_json: json = file_url.read_json()
# delete file
file_url.delete()
assert not file_url.exists()
# write text/json
file_url.write_text("test data")
file_url.write_json({"testEntry": "test data"})
assert file_url.exists()
# copy to another object
file_url.copy_to('s3://test-bucket/prefix/file-copy.json')
S3Url('s3://test-bucket/prefix/another-file-copy.json').copy_from(file_url)
# delete all filed in prefix
prefix_url = S3Url('s3://test-bucket/prefix/')
prefix_url.delete_dir()
assert not prefix_url.prefix_exists()
assert not file_url.exists()
# see tests for more examples
Development notes
Install dev dependencies: pip install .[dev] pip install .[build]
build/upload:
py -m build
py -m twine upload --repository pypi dist/*
todo - write docstrings
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
s3_url_helper-0.3.0.tar.gz
(9.1 kB
view hashes)
Built Distribution
Close
Hashes for s3_url_helper-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d57c11d10afa37ac7d96f16faedd847f3a760ee2195922efd449b1e22f3adbf2 |
|
MD5 | 2c8cdfde2fdd6d8479230cd00a3e546a |
|
BLAKE2b-256 | 0e652fc0545f8b48abff202517a2c9ac4aca32a24f5c93aea9c804553234af3c |