bucket-dir 0.4.6

Generate directory listings for S3 statically hosted content.

bucket-dir

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

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

Start with make init. This will install prerequisties and set up a poetry managed virtual environment containing all the required runtime and development dependencies.

Unit testing can be performed with make test. If you want to run pytest with other options, use poetry run pytest ....

You can execute the source code directly with poetry run bucket-dir.

Finally, you can build with make build. This will update dependencies, run security checks and analysis and finally package the code into a wheel and archive.

Publishing can be performed with make publish, but this is only intended to run in CI on commit to the main branch. If running locally, you need to have PyPI credentials set as env vars.

For other rules, see the Makefile.

If you are a collaborator, feel free to make changes directly to the main branch. Otherwise, please raise a PR. Don't forget to bump the version in pyproject.toml.

License

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