Skip to main content

Generate a hierarchy of the contents of a directory, Possibly outputting to a file

Project description

PathinBy is a tiny tool (used as a command line app or a Python module), that converts your directory structure into a nice formatted tree to use in your blog posts or other illustrations.

You need Python 2.7+ or Python 3.x to run this module

How to use

Imagine you have a directory structure like this:

http://i.imgur.com/BlW8YHn.png

As a Python module

>>> import pathinby
>>> tree = pathinby.create_path('Cats')
>>> print ('\n'.join(tree))

Here we’ve passed the directory name as an argument, there are also other arguments you can use to customize the behavior of the module, you can change those “|” and “-|” and specify an output file. Check function documentation in the source code for more details of the usage.

create_path() returns an array to give more freedom of use in different situations.

This gives the output:

|-Big
| |-Simba.bcat
|-Sylvester.cat
|-Tom.cat

As a commend line tool

$ pathinby -s Cats

This will traverse the “Cats” directory and print the contents tree to the terminal window, so running this command prints out the same directory tree like above.

the directory name can be a full or a relative path, like we did here.

By default, pathinby will do its work on the current directory if no directory is specified, in this case we specified “Cats”.

The s option means “show”, prints the output to the terminal.

Other option is

-o {path to file} -> writes the output to the specified file

Use pathinby -h anytime for help on using the command.

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pathinby-0.1.tar.gz (3.1 kB view details)

Uploaded Source

File details

Details for the file pathinby-0.1.tar.gz.

File metadata

  • Download URL: pathinby-0.1.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pathinby-0.1.tar.gz
Algorithm Hash digest
SHA256 400c30c7587fb84e36f30ddeeef193fccb4de64372aec95db5db3d4545fb089e
MD5 57b69e47faf4c59283e291713925bd7e
BLAKE2b-256 3cd0ab2a0980a6b7a6a6831ab3f7722448bd4a0c026d98891bd44c1253d12139

See more details on using hashes here.

Supported by

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