Herkules 1.2.1

Crawl directories with style

Herkules

Crawl directories with style

Illustration by George Shaw (obtained from Wikimedia Commons)

Introduction

Herkules is named after the beautiful large Hercules beetle (Dynastes hercules). It provides a recursive, filtered and sorted list of the contents of a given root directory. I find it easier to use than Python's os.scandir, but your mileage may differ.

Installation

Herkules is now developed using Python v3.12. Older versions of Python used to work and will probably still do, but you are on your own here.

Unless you want to test Herkules, simply store it somewhere and import it. For testing, you must install it into a virtual environment. The easiest way is to run

# bash
./script/bootstrap

or

# PowerShell
.\script\bootstrap.ps1

For a very simple "no-options" experience, install from PyPI and execute the included script:

# bash
pip install herkules
herkules "./directory/"

Execution

See example_herkules.py for example code and an explanation of the parameters.

Code of conduct

Please read the code of conduct before asking for help, filing bug reports or contributing to this project. Thanks!

License

Copyright (c) 2022-2025 Martin Zuther

This program is free software and licensed under the terms of the BSD 3-Clause License.

Thank you for using free software!