derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
42 lines
2.3 KiB
Markdown
42 lines
2.3 KiB
Markdown
# Indexer
|
|
|
|
Indexer is a Python script that generates an .html index of files within a selected directory. You can start from the current directory or from folder passed as first positional argument. Optionally filter by file types with --filter "\*.py". This script is an hodgepodge of older scripts [collected](https://stackoverflow.com/questions/10961378/how-to-generate-an-html-directory-list-using-python) & built over the years.
|
|
|
|
- Blog Post: https://joshbrunty.github.io/2021/10/29/indexer.html
|
|
- Video Tutorial (YouTube): https://youtu.be/-1_gVP3NtPo
|
|
|
|
## Prerequisites:
|
|
|
|
- This script requires you to have **[Python > 3.x.x](https://www.python.org/downloads/)** installed on your system.
|
|
- Ideally use the current build of **[Python 3.10](https://www.python.org/downloads/release/python-3100/)** (significantly faster processing on larger directories! 🏃)
|
|
|
|
## Usage
|
|
|
|
`python3 indexer.py /top_dir`
|
|
|
|
## Positional arguments:
|
|
|
|
- `top_dir`: top folder from which to start generating indexes (*uses current working directory/folder if not specified*).
|
|
|
|
## Optional arguments:
|
|
|
|
- `-h, --help`: show help message (along with available options)
|
|
- `-f, --filter`: only include files matching [glob](https://docs.python.org/3/library/glob.html) (i.e.`indexer.py --filter '\**/*.jpg'*`).
|
|
- `-o filename, --output-file filename`: Custom output file (by default generates "index.html")
|
|
- `-r, --recursive`: recursively process nested folders/directories (*Off/False by default*).
|
|
- `-v, --verbose`: verbosely list every processed file. (*NOTE: will take longer time with complex file tree structures on slow terminals.*)
|
|
|
|
## Features:
|
|
|
|
- File Size & Modified Time display for each file.
|
|
- Create a custom output file (*by default *index.html* is generated*).
|
|
- Ability to match/filter specified parameters using [glob](https://docs.python.org/3/library/glob.html) (*'\**/*.jpg' & '\**/*.UFD'*).
|
|
|
|
## Contact
|
|
|
|
- Email: josh [dot] brunty [at] marshall [dot] edu
|
|
- Follow @joshbrunty on Twitter [](https://twitter.com/joshbrunty)
|
|
- Indexer is Open Source via the MIT License (MIT): <a href="https://opensource.org/licenses/MIT" rel="nofollow">
|
|
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="SysScout is Open Source via MIT License">
|
|
</a>
|