Skip to main content

Generate directory listings for S3 statically hosted content.

Project description

bucket-dir

PyPI PyPI License: Apache 2.0 Code style: black

bucket-dir is a utility for generating a browsable directory tree for an AWS S3 bucket.

"Sample image"

It was built in order to host Maven and Ivy repositories in S3 and serve them via CloudFront, but it could meet other needs too.

DISCLAIMER: This utility is the product of a time boxed spike. It should not be considered production ready. Use at your own risk.

Installation

pip install bucket-dir

Usage

Run bucket-dir with the name of the bucket you wish to index as a parameter:

bucket-dir foo-bucket

Use bucket-dir --help for all arguments.

Be sure to provide the command with credentials that allow it to perform ListBucket and PutObject calls against the bucket. E.g. with aws-vault:

aws-vault exec foo-profile -- bucket-dir foo-bucket

Development

See the Makefile and run the appropriate rules.

Using the local bucket-dir script

You can use the provided bucket-dir script from the root of the repo to run the code without having to build and install it. Keep in mind that you'll need to provide a path, e.g. ./bucket-dir --help.

License

This code is open source software licensed under the Apache 2.0 License.

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

bucket-dir-0.4.2.tar.gz (8.1 kB view hashes)

Uploaded Source

Built Distribution

bucket_dir-0.4.2-py3-none-any.whl (8.7 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