Skip to main content

Print a directory tree structure in your Python code.

Project description

directory-structure

PyPI PyPI - Downloads PyPI - License GitHub watchers GitHub Repo stars GitHub forks

Print a directory tree structure in your Python code.

Download

You can simply:

pip install directory-structure

Or you can also:

  1. Clone the repository to your local machine.
  2. Enter the directory.
  3. Download necessary modules/libraries.
git clone https://github.com/gabrielstork/directory-structure.git
cd directory-structure
pip install -r requirements.txt

Examples

from directory_structure import Tree

Using absolute path as an argument.

path = Tree('C:/Users/User/Desktop/directory-structure', absolute=True)
print(path)
๐Ÿ“‚ C:
|_๐Ÿ“‚ Users
  |_๐Ÿ“‚ User
    |_๐Ÿ“‚ Desktop
      |_๐Ÿ“‚ directory-structure
        |_๐Ÿ“ .git
        |_๐Ÿ“ directory_structure
        |_๐Ÿ“„ .gitignore
        |_๐Ÿ“„ LICENSE
        |_๐Ÿ“„ pyproject.toml
        |_๐Ÿ“„ README.md
        |_๐Ÿ“„ requirements.txt
        |_๐Ÿ“„ setup.py
path = Tree('C:/Users/User/Desktop/directory-structure', absolute=False)
print(path)
๐Ÿ“‚ directory-structure
|_๐Ÿ“ .git
|_๐Ÿ“ directory_structure
|_๐Ÿ“„ .gitignore
|_๐Ÿ“„ LICENSE
|_๐Ÿ“„ pyproject.toml
|_๐Ÿ“„ README.md
|_๐Ÿ“„ requirements.txt
|_๐Ÿ“„ setup.py

Accessing a folder in current working directory.

path = Tree('./directory_structure', absolute=True)
print(path)
๐Ÿ“‚ C:
|_๐Ÿ“‚ Users
  |_๐Ÿ“‚ User
    |_๐Ÿ“‚ Desktop
      |_๐Ÿ“‚ directory-structure
        |_๐Ÿ“‚ directory_structure
          |_๐Ÿ“„ tree.py
          |_๐Ÿ“„ __init__.py
path = Tree('./directory_structure', absolute=False)
print(path)
๐Ÿ“‚ directory_structure
|_๐Ÿ“„ tree.py
|_๐Ÿ“„ __init__.py

Getting all from the directory where your current working directory is.

path = Tree('../', absolute=True)
print(path)
๐Ÿ“‚ C:
|_๐Ÿ“‚ Users
  |_๐Ÿ“‚ User
    |_๐Ÿ“‚ Desktop
      |_๐Ÿ“ directory-structure
      |_๐Ÿ“„ Discord.lnk
      |_๐Ÿ“„ Spotify.lnk
      |_๐Ÿ“„ Steam.lnk
      |_๐Ÿ“„ Telegram.lnk
      |_๐Ÿ“„ Visual Studio Code.lnk
      |_๐Ÿ“„ WhatsApp.lnk
path = Tree('../', absolute=False)
print(path)
๐Ÿ“‚ Desktop
|_๐Ÿ“ directory-structure
|_๐Ÿ“„ Discord.lnk
|_๐Ÿ“„ Spotify.lnk
|_๐Ÿ“„ Steam.lnk
|_๐Ÿ“„ Telegram.lnk
|_๐Ÿ“„ Visual Studio Code.lnk
|_๐Ÿ“„ WhatsApp.lnk

forthebadge forthebadge

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

directory-structure-1.1.2.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

directory_structure-1.1.2-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file directory-structure-1.1.2.tar.gz.

File metadata

  • Download URL: directory-structure-1.1.2.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for directory-structure-1.1.2.tar.gz
Algorithm Hash digest
SHA256 e43f579c2dc41b8f5d814d43b38abf51c169c0e1bcbbc84faef477d747e079b0
MD5 18646df8e4e800001971c392287b7816
BLAKE2b-256 b01021c893bfa9dd302e0b8fcb23f17efbf20f0cfbbb3b84b37e4d15c66aa3d2

See more details on using hashes here.

File details

Details for the file directory_structure-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: directory_structure-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for directory_structure-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ce053f71e8ab2aaf77a88e26ca3e729acf6ecf828b43db0eeac3858ae62dd259
MD5 ae83883740e367ba6aaae2d340f3007c
BLAKE2b-256 692498f287bc87651187d030caa579e3d91cb48b73bb103f3b3a4cb8eed2074f

See more details on using hashes here.

Supported by

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