Skip to main content

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


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

Uploaded Source

Built Distribution

botree-0.4.1-py3-none-any.whl (8.5 kB view hashes)

Uploaded Python 3

Supported by

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