Skip to main content

Visualizes file paths using D3.js

Project description

d3tree

d3tree is a Python package used to visualize file paths using D3.js. The package is inspired by Dirtree, a similar library written in Ruby.

Installation

Install d3tree in your virtual environment of choice using:

python -m pip install d3tree

Usage

d3tree is a command-line utility that can be used as follows:

Usage: d3tree [OPTIONS] [PATH]

Options:
  -v, --version                   Print version
  -o, --output TEXT               Specify filepath to write HTML output
  -t, --template [tree|circles|flame|treemap]
                                  Specify template
  --help                          Show this message and exit.

Examples

Visualize current directory:

ls | d3tree -o output.html

Or use a file that contains the filepaths:

cat filepaths.txt | d3tree -o output.html

Features not implemented

The following features are not implemented (yet):

  • shell completion
  • screenshot feature
  • using local JS dependencies

Feel free to create a PR for these or other features.

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

d3tree-0.2.2.tar.gz (11.9 kB view hashes)

Uploaded Source

Built Distribution

d3tree-0.2.2-py3-none-any.whl (13.3 kB view hashes)

Uploaded Python 3

Supported by

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