Print a directory tree structure in your Python code.

Overview

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

Owner
Gabriel Stork
Python
Gabriel Stork
Run-time type checker for Python

This library provides run-time type checking for functions defined with PEP 484 argument (and return) type annotations. Four principal ways to do type

Alex Grรถnholm 1.1k Dec 19, 2022
An interpreter for the X1 bytecode.

X1 Bytecode Interpreter The X1 Bytecode is bytecode designed for simplicity in programming design and compilation. Bytecode Instructions push

Thanasis Tzimas 1 Jan 15, 2022
Performant type-checking for python.

Pyre is a performant type checker for Python compliant with PEP 484. Pyre can analyze codebases with millions of lines of code incrementally โ€“ providi

Facebook 6.2k Jan 07, 2023
Find usage statistics (imports, function calls, attribute access) for Python code-bases

Python Library stats This is a small library that allows you to query some useful statistics for Python code-bases. We currently report library import

Francisco Massa 13 May 02, 2022
This is a Python program to get the source lines of code (SLOC) count for a given GitHub repository.

This is a Python program to get the source lines of code (SLOC) count for a given GitHub repository.

Nipuna Weerasekara 2 Mar 10, 2022
CodeAnalysis - Static Code Analysis: a code comprehensive analysis platform

TCA, Tencent Cloud Code Analysis English | ็ฎ€ไฝ“ไธญๆ–‡ What is TCA Tencent Cloud Code A

Tencent 1.3k Jan 07, 2023
๐Ÿฆ” PostHog is developer-friendly, open-source product analytics.

PostHog provides open-source product analytics, built for developers. Automate the collection of every event on your website or app, with no need to send data to 3rd parties. With just 1 click you ca

PostHog 10.3k Jan 01, 2023
Alarmer is a tool focus on error reporting for your application.

alarmer Alarmer is a tool focus on error reporting for your application. Installation pip install alarmer Usage It's simple to integrate alarmer in yo

long2ice 20 Jul 03, 2022
Pymwp is a tool for automatically performing static analysis on programs written in C

pymwp: MWP analysis in Python pymwp is a tool for automatically performing static analysis on programs written in C, inspired by "A Flow Calculus of m

Static Analyses of Program Flows: Types and Certificate for Complexity 2 Dec 02, 2022
Static type checker for Python

Static type checker for Python Speed Pyright is a fast type checker meant for large Python source bases. It can run in a โ€œwatchโ€ mode and performs fas

Microsoft 9.4k Jan 07, 2023
fixup: Automatically add and remove python import statements

fixup: Automatically add and remove python import statements The goal is that running fixup my_file.py will automatically add or remove import stateme

2 May 08, 2022
TidyPy is a tool that encapsulates a number of other static analysis tools and makes it easy to configure, execute, and review their results.

TidyPy Contents Overview Features Usage Docker Configuration Ignoring Issues Included Tools Included Reporters Included Integrations Extending TidyPy

Jason Simeone 33 Nov 27, 2022
Print a directory tree structure in your Python code.

directory-structure Print a directory tree structure in your Python code. Download You can simply: pip install directory-structure Or you can also: Cl

Gabriel Stork 45 Dec 19, 2022
Typing-toolbox for Python 3 _and_ 2.7 w.r.t. PEP 484.

Welcome to the pytypes project pytypes is a typing toolbox w.r.t. PEP 484 (PEP 526 on the road map, later also 544 if it gets accepted). Its main feat

Stefan Richthofer 188 Dec 29, 2022
Guesslang detects the programming language of a given source code

Detect the programming language of a source code

Y. SOMDA 618 Dec 29, 2022
Typical: Fast, simple, & correct data-validation using Python 3 typing.

typical: Python's Typing Toolkit Introduction Typical is a library devoted to runtime analysis, inference, validation, and enforcement of Python types

Sean 170 Dec 26, 2022
A formatter for Python files

YAPF Introduction Most of the current formatters for Python --- e.g., autopep8, and pep8ify --- are made to remove lint errors from code. This has som

Google 13k Dec 31, 2022
The uncompromising Python code formatter

The Uncompromising Code Formatter โ€œAny color you like.โ€ Black is the uncompromising Python code formatter. By using it, you agree to cede control over

Python Software Foundation 30.7k Dec 28, 2022
Inspects Python source files and provides information about type and location of classes, methods etc

prospector About Prospector is a tool to analyse Python code and output information about errors, potential problems, convention violations and comple

Python Code Quality Authority 1.7k Dec 31, 2022
A very minimalistic python module that lets you track the time your code snippets take to run.

Clock Keeper A very minimalistic python module that lets you track the time your code snippets take to run. This package is available on PyPI! Run the

Rajdeep Biswas 1 Jan 19, 2022