Metadata-Version: 2.5
Name: xnjk
Version: 0.0.2
Summary: Render a directory as an indented text tree.
Project-URL: Homepage, https://github.com/lqxnjk/xnjk
Author: lqxnjk
License: MIT
License-File: LICENSE
Keywords: console,directory,filesystem,listing,tree
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# xnjk

Render a directory as a tree you can paste into a README or a bug report.

## Install

```console
pip install xnjk
```

## Usage

```python
from xnjk import render_tree

print(render_tree("src", n_max_depth=2))
# src/
# ├── pkg/
# │   └── core.py
# └── main.py
```

## Options

| Option | Default | Meaning |
| --- | --- | --- |
| `n_max_depth` | 3 | levels of nesting to descend |
| `n_show_files` | `True` | include files, not just directories |
| `n_max_entries` | 500 | stop after this many lines |

## Guarantees

Directories sort before files, both case-insensitively, so output is stable
across platforms. Unreadable directories are logged and skipped instead of
raising. Symlinks are not followed, so a loop cannot hang the walk.

## License

MIT
