Skip to main content

Create an html file that shows the directory listing structure of an s3 bucket.

Project description

ye3sld

Créer un fichier HTML qui affiche la structure de la liste des dossiers d'un bucket S3.

Create an html file that show the directory listing structure of an s3 bucket.

Features

  • Works with all S3 compatible storage API implementations (Amazon, Garage, MinIO, etc.)
  • GUI (Graphical User Interface) mode and CLI (Command Line Interface) mode
  • Enter the Endpoint URL, Access key ID, Secret access key, Region, Bucket name
  • Filter on a specific folder in S3 bucket (Prefix)
  • Filter with regex to exclude certain patterns (eg: .tmp, .old, backup_.*)
  • Can list all files, even if there are more than 1000 files in the bucket (S3 pagination)
  • Select the output HTML file location: in local and S3 bucket (optional)
  • Output HTML : Nice tree structure with a smooth effect when moving the mouse over the list items
  • Output HTML : List items are clickable, with customizable href base url

The main goal is to display the entire folder structure on a single page. Really light and simple, without any action button or entry box on the output html page.

Prerequisite

Python and boto3
tkinter if you want a Graphical User Interface

Simple usage

1) Install

Open the command prompt and type :

pip install ye3sld

2) Run

From the command prompt,

For GUI mode, type :

ye3sld

Fill in the fields in the GUI

Example Image

For CLI mode, type :

ye3sld --cli --endpoint_url="http://MYWEBSITE" --aws_access_key_id="MYID" --aws_secret_access_key="MYSECRET" --bucket_name="MYBUCKET" --upload --overwrite --exclude=".tmp, .old"

To show all CLI options : ye3sld --help

3) Verify

Open the HTML output file in your local folder or in your s3 bucket

Example Image

To view the HTML code Click here

Version

name version
ye3sld 1.0.0

Changelog

[1.0.0] - 2024-12-30

Added

  • première : first release

ToDo

Feel free to contribute or share your ideas for new features, you can contact me here on github or by email. I speak French, you can write to me in other languages ​​I will find ways to translate.

License

MIT
author: palw3ey
maintainer: palw3ey
email: palw3ey@gmail.com
website: https://github.com/palw3ey/ye3sld

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

ye3sld-1.0.0.tar.gz (81.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ye3sld-1.0.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file ye3sld-1.0.0.tar.gz.

File metadata

  • Download URL: ye3sld-1.0.0.tar.gz
  • Upload date:
  • Size: 81.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.3

File hashes

Hashes for ye3sld-1.0.0.tar.gz
Algorithm Hash digest
SHA256 188db6e51f32031215af2a4fe1ed70d4e96b66e4c3a776be863c5130017bf6a9
MD5 cfcabc1abd3e6d9e0f64180f3d68fd6c
BLAKE2b-256 59ae37c38592e1ef91ed11d240b0ea5789e4fe815cc82b923508b3c20324aaa6

See more details on using hashes here.

File details

Details for the file ye3sld-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: ye3sld-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.3

File hashes

Hashes for ye3sld-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fdd87623924f36fd517b73ed4ae8bdebde465961e54b85498a199444d9cd73f7
MD5 4eb822a7a98c9be68868b35c87ff67c4
BLAKE2b-256 577b0e177e0977b55fc1ad5625b599b1e3652c9a2f3c025c730e48adeba07659

See more details on using hashes here.

Supported by

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