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.1

Changelog

[1.0.1] - 2025-01-02

Fixed

  • messagebox was not showing because tkinter was not imported in the generate_html function. Now, tkinter is imported at the top of the script, inside a try except.

[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.1.tar.gz (81.4 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.1-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ye3sld-1.0.1.tar.gz
Algorithm Hash digest
SHA256 f93e78030d6c7af0727c09be377791891f6b4d1950305ac6ef787ae8edecbeeb
MD5 2f0323d2a22a3145de700214cbbdbbcc
BLAKE2b-256 475a1b1f7d64e695c4a2748cf87b650505e5681378119ed8fdf104f47f4dd051

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ye3sld-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 04c688a38ca415501248e3a8d855f0a9b09e467eb6f9fa42cc4a01a3c19b9eaa
MD5 6b381376a69537fd2035e7ce5e4b82cc
BLAKE2b-256 af2812d7d0fea71c0572552ebcc4901a9155f1c217c4b92ff3c01df781f8dd46

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