A friendly wrapper for boto3.
Project description
Botree: a friendly wrapper for boto3
Botree is a higher level API for AWS services / Boto3 classes and aims to make Boto3 experience easier.
🧰 Supported AWS services
Currently, there are just some Boto3 wrapped classes.
- ✔️ S3
- ✔️ Secrets
- ✔️ CloudWatch
- ✔️ Cost Explorer
- ✔️ Secrets Manager
💻 Basic usage
To start a Botree session, use the following:
import botree
session = botree.session("us-east-1", profile="dev")
Create a bucket:
session.s3.create_bucket("sample-bucket")
session.s3.list_buckets()
Note that all S3 operations will use Python's pathlib to handle directory paths, so let's import it:
from pathlib import Path
Download and upload:
source_file = Path("sample_source_file.png")
target_file = Path("sample_target_file.png")
session.s3.bucket("sample-bucket").upload(source_file, target_file)
session.s3.bucket("sample-bucket").download(source_file, target_file)
📜 Docs
The docs are under development, but it's (very) early stage is already available.
🏗️ Development
Botree relies on PDM.
Install the Python dependencies with:
pdm install
⚗️ Testing
pdm run pytest --cov=botree tests/
🖖 Contributors
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
botree-0.4.1.tar.gz
(9.4 kB
view details)
Built Distribution
File details
Details for the file botree-0.4.1.tar.gz
.
File metadata
- Download URL: botree-0.4.1.tar.gz
- Upload date:
- Size: 9.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.8.0 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a94d0339ef362412edd7a812f78644f1402d33c5561e4b83915d376788a35f24 |
|
MD5 | 828080e91b63ddb5bfc41aac7efe32f7 |
|
BLAKE2b-256 | 2b8728827f078cde88250e1174b1de88fe506100a92bbfd4c59d2375fe50875c |
File details
Details for the file botree-0.4.1-py3-none-any.whl
.
File metadata
- Download URL: botree-0.4.1-py3-none-any.whl
- Upload date:
- Size: 8.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.8.0 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 548807deeb864ee121dc40891ecfe35710fbefde44b34a8d4a5a4c3e20649986 |
|
MD5 | 9e8b4a4f094b55ec0eb38a26d04df03d |
|
BLAKE2b-256 | bcf2a3bf4fb2ae467a841c6fefcaf411a09664f833ff960f858f9fb7408f7a75 |