/python-wiring-the-filesystem

WTF (Wiring The Filesystem) is a directory analysis tool designed to visualize the intricate parent-child relationships in file hierarchies, particularly useful for software component directories. Using customizable mapping tables for file extensions, colors, and symbols, WTF helps engineers untangle the structure of complex projects with ease.

Primary LanguagePythonOtherNOASSERTION

Wiring The Filesystem (WTF)

Overview

  • Documentation Status
  • GitHub Actions Build Status
  • Coverage Status
  • PyPI Package latest release
  • PyPI Wheel
  • Supported versions
  • Supported implementations
  • Commits since latest release

WTF (Wiring The Filesystem) is a directory analysis tool designed to visualize the intricate parent-child relationships in file hierarchies, particularly useful for software component directories. Using customizable mapping tables for file extensions, colors, and symbols, WTF helps engineers untangle the structure of complex projects with ease.

Installation

pip install wiring-the-filesystem

You can also install the in-development version with:

pip install https://github.com/cosgroma/python-wiring-the-filesystem/archive/main.zip

Documentation

The official documentation is hosted on Read the Docs.

Development

To run all the tests run:

tox

PYTEST_ADDOPTS=--cov-append tox will append coverage to an existing .coverage file.