S3 navigation using object, inspired by pathlib.Path
Project description
Installation
pip install pathlibs3
Usage
Create a PathlibS3 Object
from pathlibs3.pathlibs3 import S3Path
# Create a pathlibs3
client = boto3.client("s3", region_name="us-east-1")
bucket = "test-bucket"
# Create an object to s3://test-bucket/myfolder
s3_path_to_myfolder = S3Path(client, bucket, "myfolder/")
# You can also concatenate object
# Create an object to s3://test-bucket/myfile/random_file.txt
s3_path_to_random_file = s3_path_to_myfolder / "random_file.txt"
Iter over a directory
# Iter over this directory
for path in s3_path.iterdir():
print(path)
# Iter over this directory recursively
for path in s3_path.iterdir(recursive=True):
print(path)
Use classic pathlib.Path function
parent and parents
>> s3_path_to_myfolder = S3Path(client, bucket, "myfolder/folder1/folder2")
>> s3_path_to_myfolder.parent
S3Path(client, bucket, "myfolder/folder1")
>> s3_path_to_myfolder.parents
[S3Path(client, bucket, "myfolder/folder1"), S3Path(client, bucket, "myfolder")]
name
>> s3_path_to_myfolder = S3Path(client, bucket, "myfolder/folder1/folder2/test.txt")
>> s3_path_to_myfolder.name
"test.txt"
exists
>> s3_path_to_myfolder = S3Path(client, bucket, "myfolder/folder1/folder2/test.txt")
>> s3_path_to_myfolder.exists()
True
Copy file or folder
Copy from s3 to local
# Create an pathlibs3 object
s3_path_to_myfolder = S3Path(client, bucket, "myfolder/")
# Create a pathlib object
local_path = Path("/tmp/local_folder")
# Will download the s3 folder localy
S3Path.copy(s3_path_to_myfolder, local_path)
# You may also use string for local path
# Example: copy from s3 to local dir using string
S3Path.copy(s3_path_to_myfolder, "/tmp/local_folder")
Copy from local to s3
# Create an pathlibs3 object
s3_path_to_myfolder = S3Path(client, bucket, "myfolder/")
# Create a pathlib object
local_path = Path("/tmp/local_folder")
# Will download the s3 folder localy
S3Path.copy(local_path, s3_path_to_myfolder)
Copy from s3 to s3
# Create an pathlibs3 object
s3_path_to_myfolder = S3Path(client, bucket, "myfolder/")
# Create another pathlibs3 object
s3_path_to_anotherfolder = S3Path(client, bucket, "anotherfolder/")
# Will download the s3 folder localy
S3Path.copy(s3_path_to_myfolder, s3_path_to_anotherfolder)
Delete a folder
# Create an pathlibs3 object
s3_path_to_myfolder = S3Path(client, bucket, "myfolder/")
s3_path_to_myfolder.delete()
Move a folder
# Create an pathlibs3 object
s3_path_to_myfolder = S3Path(client, bucket, "myfolder/")
s3_path_other_folder = S3Path(client, bucket, "myotherfolder/")
S3Path.move(s3_path_to_myfolder, s3_path_other_folder)
Contribution
run test
run test with poetry run python -m pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pathlibs3-1.1.3.tar.gz
(3.5 kB
view hashes)
Built Distribution
Close
Hashes for pathlibs3-1.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3eab79147ed26bd6ffa12dce058a44e7c4f728d9d52c3a92a22adf39dde9685e |
|
MD5 | 63eb725b469396f6f8cef912f4a4c387 |
|
BLAKE2b-256 | b13a7caf9bb130b78fbc361979100069ceeb17fbe4184defe49b87ac342e80a1 |