seedir

0.5.1 · active · verified Wed Apr 15

seedir is a Python package designed for creating, editing, and displaying folder tree diagrams. It provides a straightforward way to visualize directory structures, supporting both real file systems and 'fake' directory objects for testing or presentation. The library is actively maintained, with its current version being 0.5.1, and receives regular updates.

Warnings

breaking The `seedir.command_line` module was removed and the command-line interface was revamped.
Fix: Instead of importing or calling `seedir.command_line`, use `seedir` directly in the terminal (e.g., `seedir --help`) or `python -m seedir`.
breaking The `emoji` package is no longer a core dependency for all installations.
Fix: If you use the 'emoji' style or other emoji-dependent features, you must install `seedir` with the `[emoji]` extra: `pip install seedir[emoji]`. Otherwise, an error will be raised when attempting to use an emoji style.
deprecated The `slash` parameter for defining folder endings has been deprecated.
Fix: Use the `folderend` parameter instead to specify characters at the end of folder lines.
gotcha The `itemlimit` parameter for restricting the number of items now accepts a 2-tuple.
Fix: To specify separate limits for folders and files, pass a 2-tuple `(folder_limit, file_limit)` to `itemlimit`. For example, `itemlimit=(5, 10)` will show up to 5 folders and 10 files per directory.
gotcha New parameters were introduced for handling errors during directory listing.
Fix: If you encounter permissions errors or other `OSError` types when `seedir` tries to list directory contents, you can now use `acceptable_listdir_errors` (e.g., `[PermissionError]`) to ignore them and `denied_string` to mark those entries.
gotcha The `seedir()` function now directly accepts `pathlib.Path` objects.
Fix: You can pass `pathlib.Path` objects directly to the `path` argument of `sd.seedir()`, removing the need for explicit string conversions.

Install

pip install seedir Basic Installation
pip install seedir[emoji] Installation with Emoji Support

Imports

seedir
```
import seedir as sd
```
seedir.seedir
wrong:
```
from seedir.seedir import seedir
```
correct:
```
from seedir.realdir import seedir
```
The internal module `seedir.seedir` was renamed to `seedir.realdir` in an earlier version. While `sd.seedir()` (after `import seedir as sd`) still works, direct imports from `seedir.seedir` will fail.
seedir.command_line
wrong:
```
import seedir.command_line
```
correct:
```
N/A (removed)
```
The `seedir.command_line` module and its functionality were removed in version 0.4.2. Command-line execution is now handled via `seedir` directly or `python -m seedir`.

Quickstart

This quickstart demonstrates how to use `seedir.seedir()` to print a directory tree. It first creates a temporary directory structure and then visualizes it using the 'lines' style, limiting the depth for conciseness. Finally, it cleans up the created dummy directory.

import seedir as sd
import os

# Create a dummy directory structure for demonstration
# In a real scenario, you'd point to an existing path.

# Create a temporary directory and some files/folders
current_dir = os.getcwd()
dummy_path = os.path.join(current_dir, 'seedir_example')
os.makedirs(os.path.join(dummy_path, 'folder1', 'subfolder_a'), exist_ok=True)
os.makedirs(os.path.join(dummy_path, 'folder2'), exist_ok=True)
with open(os.path.join(dummy_path, 'file1.txt'), 'w') as f: f.write('content')
with open(os.path.join(dummy_path, 'folder1', 'file2.txt'), 'w') as f: f.write('content')

# Generate and print the directory tree
print(f"\nDirectory tree for '{dummy_path}':")
sd.seedir(path=dummy_path, style='lines', depthlimit=3)

# Clean up the dummy directory
import shutil
shutil.rmtree(dummy_path)
print("\nCleaned up dummy directory.")

view raw JSON →