packtree

packtree is a Python package that makes ASCII tree representation of a package's variables or a folder's content.

Table of Contents

• Author
• Install and Compile
• Using packtree
• Be Kind
• License

Author

• Patricio Cubillos, Space Research Institute, Graz, Austria. patricio.cubillos@oeaw.ac.at

Install and Compile

From pip

Run from the shell:

pip install packtree

From Github

Clone the repository to your local machine and install it with these shell commands:

git clone https://github.com/pcubillos/packtree
python ./setup.py install

Note that you may need to prepend sudo to the previous calls. If you don't have those permissions, you can still use the Github-cloned code, as long as you add the python path to the source code.

Using packtree

The following demo shows what packtree produces. First start a Python interpreter session:

>>> import packtree as tree

>>> # Genereate the ASCII tree representation of the packtree package:
>>> tree.packagetree(tree)

packtree
|-- filetree
`-- packagetree


>>> # Generate the ASCII tree representation of the directory that contains the packtree package:
>>> tree.filetree(".")

packtree
|-- LICENSE
|-- README.md
|-- packtree
|   |-- __init__.py
|   `-- tree.py
`-- setup.py

Be Kind

Please, be kind and acknowledge and/or refer to the packtree site (github.com/pcubillos/packtree) if it was useful for you.

License

Copyright (c) 2016 Patricio Cubillos and contributors. packtree is open-source software under the MIT license (see LICENSE).