pretty-mod 0.1.1__cp310-cp310-win32.whl → 0.2.0__cp310-cp310-win32.whl

pretty_mod/_pretty_mod.pyi

@@ -16,5 +16,5 @@ class ModuleTreeExplorer:
 def display_tree(
     root_module_path: str, max_depth: int = 2, quiet: bool = False
 ) -> None: ...
-def display_signature(import_path: str) -> str: ...
+def display_signature(import_path: str, quiet: bool = False) -> str: ...
 def import_object(import_path: str) -> Any: ...

pretty_mod/cli.py

@@ -31,6 +31,11 @@ def main():
     sig_parser.add_argument(
         "import_path", help="Import path to the function (e.g., 'json:loads')"
     )
+    sig_parser.add_argument(
+        "--quiet",
+        action="store_true",
+        help="Suppress download messages",
+    )
 
     args = parser.parse_args()
 
@@ -38,7 +43,7 @@ def main():
         if args.command == "tree":
             display_tree(args.module, args.depth, args.quiet)
         elif args.command == "sig":
-            print(display_signature(args.import_path))
+            print(display_signature(args.import_path, args.quiet))
         else:
             parser.print_help()
             sys.exit(1)

pretty_mod-0.2.0.dist-info/METADATA

@@ -0,0 +1,250 @@
+Metadata-Version: 2.4
+Name: pretty-mod
+Version: 0.2.0
+License-File: LICENSE
+Summary: A python module tree explorer for LLMs (and humans)
+Author-email: zzstoatzz <thrast36@gmail.com>
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# pretty-mod
+
+a python module tree explorer for LLMs (and humans)
+
+> [!IMPORTANT]
+> for all versions `>=0.1.0`, wheels for different operating systems are built via `maturin` and published to pypi, install `<0.1.0` for a pure python version
+
+> [!NOTE]
+> Starting from v0.2.0, output includes colors by default. Use `PRETTY_MOD_NO_COLOR=1` to disable.
+
+```bash
+# Explore module structure
+» uvx pretty-mod tree json
+📦 json
+├── 📜 __all__: dump, dumps, load, loads, JSONDecoder, JSONDecodeError, JSONEncoder
+├── ⚡ functions: dump, dumps, load, loads
+├── 📦 decoder
+│   ├── 📜 __all__: JSONDecoder, JSONDecodeError
+│   └── 🔷 classes: JSONDecodeError, JSONDecoder
+├── 📦 encoder
+│   ├── 🔷 classes: JSONEncoder
+│   └── ⚡ functions: py_encode_basestring, py_encode_basestring_ascii
+├── 📦 scanner
+│   └── 📜 __all__: make_scanner
+└── 📦 tool
+    └── ⚡ functions: main
+
+# Inspect function signatures (even if the package is not installed)
+» uv run pretty-mod sig fastmcp:FastMCP --quiet
+📎 FastMCP
+├──  Parameters:
+├──  self
+├──  name: str | None=None
+├──  instructions: str | None=None
+├──  auth: OAuthProvider | None=None
+├──  lifespan: Callable[[FastMCP[LifespanResultT]], AbstractAsyncContextManager[LifespanResultT]] | None=None
+├──  tool_serializer: Callable[[Any], str] | None=None
+├──  cache_expiration_seconds: float | None=None
+├──  on_duplicate_tools: DuplicateBehavior | None=None
+├──  on_duplicate_resources: DuplicateBehavior | None=None
+├──  on_duplicate_prompts: DuplicateBehavior | None=None
+├──  resource_prefix_format: Literal['protocol', 'path'] | None=None
+├──  mask_error_details: bool | None=None
+├──  tools: list[Tool | Callable[..., Any]] | None=None
+├──  dependencies: list[str] | None=None
+├──  include_tags: set[str] | None=None
+├──  exclude_tags: set[str] | None=None
+├──  log_level: str | None=None
+├──  debug: bool | None=None
+├──  host: str | None=None
+├──  port: int | None=None
+├──  sse_path: str | None=None
+├──  message_path: str | None=None
+├──  streamable_http_path: str | None=None
+├──  json_response: bool | None=None
+└──  stateless_http: bool | None=None
+```
+
+## installation
+
+```bash
+uv add pretty-mod
+```
+
+
+## cli
+
+`pretty-mod` includes a command-line interface for shell-based exploration:
+
+> [!IMPORTANT]
+> all commands below can be run ephemerally with `uvx`, e.g. `uvx pretty-mod tree json`
+
+```bash
+# Explore module structure
+pretty-mod tree json
+
+# Go deeper into the tree with --depth
+pretty-mod tree requests --depth 3
+
+# Display function signatures  
+pretty-mod sig json:loads
+pretty-mod sig os.path:join
+
+# Explore packages even without having them installed
+pretty-mod tree django
+pretty-mod tree flask --depth 1
+
+# Use --quiet to suppress download messages
+pretty-mod tree requests --quiet
+
+# Version specifiers - explore specific versions
+pretty-mod tree toml@0.10.2
+pretty-mod sig toml@0.10.2:loads
+
+# Submodules with version specifiers (correct syntax)
+pretty-mod tree prefect.server@2.10.0  # ✅ Works
+pretty-mod tree prefect@2.10.0.server  # ❌ Invalid - version must come last
+
+# Package name differs from module name
+pretty-mod tree pydocket::docket       # PyPI package 'pydocket' contains module 'docket'
+pretty-mod tree pillow::PIL            # PyPI package 'pillow' contains module 'PIL'
+pretty-mod tree pillow::PIL@10.0.0    # Specific version of pillow
+pretty-mod sig pillow::PIL.Image:open  # Works with signatures too
+```
+
+## python sdk
+
+```python
+from pretty_mod import display_tree
+
+# Explore a module structure  
+display_tree("collections", max_depth=2)
+```
+
+<details>
+<summary>Example output</summary>
+
+```text
+display_tree("collections", max_depth=2)
+
+📦 collections
+├── 📜 __all__: ChainMap, Counter, OrderedDict, UserDict, UserList, UserString, defaultdict, deque, namedtuple
+├── 🔷 classes: ChainMap, Counter, OrderedDict, UserDict, UserList, UserString, defaultdict, deque
+├── ⚡ functions: namedtuple
+└── 📦 abc
+    ├── 📜 __all__: Awaitable, Coroutine, AsyncIterable, AsyncIterator, AsyncGenerator, Hashable, Iterable, Iterator, Generator, Reversible, Sized, Container, Callable, Collection, Set, MutableSet, Mapping, MutableMapping, MappingView, KeysView, ItemsView, ValuesView, Sequence, MutableSequence, ByteString, Buffer
+    └── 🔷 classes: AsyncGenerator, AsyncIterable, AsyncIterator, Awaitable, Buffer, ByteString, Callable, Collection, Container, Coroutine, Generator, Hashable, ItemsView, Iterable, Iterator, KeysView, Mapping, MappingView, MutableMapping, MutableSequence, MutableSet, Reversible, Sequence, Set, Sized, ValuesView
+```
+</details>
+
+
+
+```python
+from pretty_mod import display_signature
+
+# Display the signature of a callable (function, class constructor, etc.)
+print(display_signature("json:loads"))
+```
+
+<details>
+<summary>Example output</summary>
+
+```text
+📎 loads
+├── Parameters:
+├── s
+├── *
+├── cls=None
+├── object_hook=None
+├── parse_float=None
+├── parse_int=None
+├── parse_constant=None
+├── object_pairs_hook=None
+└── **kw
+```
+</details>
+
+## customization
+
+pretty-mod supports extensive customization through environment variables:
+
+### display characters
+
+```bash
+# Use ASCII-only mode for terminals without Unicode support
+PRETTY_MOD_ASCII=1 pretty-mod tree json
+
+# Customize individual icons
+PRETTY_MOD_MODULE_ICON="[M]" pretty-mod tree json
+PRETTY_MOD_FUNCTION_ICON="fn" pretty-mod tree json
+PRETTY_MOD_CLASS_ICON="cls" pretty-mod tree json
+```
+
+### colors
+
+pretty-mod uses an earth-tone color scheme by default:
+
+```bash
+# Disable colors entirely
+PRETTY_MOD_NO_COLOR=1 pretty-mod tree json
+# or use the standard NO_COLOR environment variable
+NO_COLOR=1 pretty-mod tree json
+
+# Override specific colors with hex values
+PRETTY_MOD_MODULE_COLOR="#FF6B6B" pretty-mod tree json
+PRETTY_MOD_FUNCTION_COLOR="#4ECDC4" pretty-mod tree json
+```
+
+available color environment variables:
+- `PRETTY_MOD_MODULE_COLOR` - Modules/packages (default: #8B7355)
+- `PRETTY_MOD_FUNCTION_COLOR` - Functions (default: #6B8E23)
+- `PRETTY_MOD_CLASS_COLOR` - Classes (default: #4682B4)
+- `PRETTY_MOD_CONSTANT_COLOR` - Constants (default: #BC8F8F)
+- `PRETTY_MOD_EXPORTS_COLOR` - __all__ exports (default: #9370DB)
+- `PRETTY_MOD_SIGNATURE_COLOR` - Signatures (default: #5F9EA0)
+- `PRETTY_MOD_TREE_COLOR` - Tree structure lines (default: #696969)
+- `PRETTY_MOD_PARAM_COLOR` - Parameter names (default: #708090)
+- `PRETTY_MOD_TYPE_COLOR` - Type annotations (default: #778899)
+- `PRETTY_MOD_DEFAULT_COLOR` - Default values (default: #8FBC8F)
+- `PRETTY_MOD_WARNING_COLOR` - Warning messages (default: #DAA520)
+
+## examples
+
+see the [`examples/`](examples/) directory for more detailed usage patterns and advanced features.
+
+## development
+
+```bash
+gh repo clone zzstoatzz/pretty-mod && cd pretty-mod
+just --list # see https://github.com/casey/just
+```
+
+<details>
+<summary>Performance Testing</summary>
+
+The performance test script (`scripts/perf_test.py`) supports both single-run exploration and proper benchmarking with multiple iterations:
+
+```bash
+# Run a proper benchmark with multiple iterations
+./scripts/perf_test.py json --benchmark
+./scripts/perf_test.py urllib --benchmark --runs 100 --warmup 10
+
+# Compare performance between local and published versions
+just compare-perf prefect 2
+
+# Benchmark multiple modules
+just benchmark-modules
+
+# Or use shell timing for quick single-run comparisons
+time ./scripts/perf_test.py numpy --depth 3
+time uvx pretty-mod tree numpy --depth 3
+```
+
+Benchmark mode provides:
+- Warmup runs to account for cold starts
+- Multiple iterations for statistical significance
+- Mean, standard deviation, min/max timing statistics
+- Silent operation (no tree output) for accurate timing
+
+</details>

pretty_mod-0.2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+pretty_mod-0.2.0.dist-info/METADATA,sha256=3XGAL8KBJCHgmfBpLqfmWJplk_f6dS_0DFqRCbh3_4o,8516
+pretty_mod-0.2.0.dist-info/WHEEL,sha256=aBacha0FcFMzjQuVTMCEUEJSXL9SWMbeMaJPxWjGHqE,92
+pretty_mod-0.2.0.dist-info/entry_points.txt,sha256=aNlomjGTypAOUeZiSZ4OYFY-QVq2KmDXkO9QFS45uW4,49
+pretty_mod-0.2.0.dist-info/licenses/LICENSE,sha256=J2cPHis9ZpzSonH9dVASFNtKrAdQmI-6qYBlivuubwA,1087
+pretty_mod/__init__.py,sha256=FWM2poN7eHWyVNly7AqU0RJlDHCrxhnk_k6LPFgyXcc,106
+pretty_mod/_pretty_mod.cp310-win32.pyd,sha256=7kazXVtaM5IL-rZkO7brRKm9fNELrrcJ06PL4XEARik,5281280
+pretty_mod/_pretty_mod.pyi,sha256=NXm_WH1UwB6qLrB6e-U21u0UwKL2w3dQWIiF-TNBxvU,682
+pretty_mod/cli.py,sha256=xxYpUM-vCQ2XF5X0_z1cRyjWvnX8jDbVQuaZ0N23QAQ,1668
+pretty_mod/explorer.py,sha256=3w-oY7edQzQMlAOVUSBqPJ94tiuJZXc45yD9bDHFsTs,268
+pretty_mod/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pretty_mod-0.2.0.dist-info/RECORD,,

pretty_mod-0.1.1.dist-info/METADATA

@@ -1,173 +0,0 @@
-Metadata-Version: 2.4
-Name: pretty-mod
-Version: 0.1.1
-License-File: LICENSE
-Summary: A module tree explorer for LLMs (and humans)
-Author-email: zzstoatzz <thrast36@gmail.com>
-License: MIT
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
-
-# pretty-mod
-
-a module tree explorer for LLMs (and humans)
-
-> [!IMPORTANT]
-> for all versions `>=0.1.0`, wheels for different operating systems are built via `maturin` and published to pypi, install `<0.1.0` for a pure python version
-
-```bash
-» uvx pretty-mod tree json
-📦 json
-├── 📜 __all__: dump, dumps, load, loads, JSONDecoder, JSONDecodeError, JSONEncoder
-├── ⚡ functions: dump, dumps, load, loads
-├── 📦 decoder
-│   ├── 📜 __all__: JSONDecoder, JSONDecodeError
-│   └── 🔷 classes: JSONDecodeError, JSONDecoder
-├── 📦 encoder
-│   ├── 🔷 classes: JSONEncoder
-│   └── ⚡ functions: py_encode_basestring, py_encode_basestring_ascii
-├── 📦 scanner
-│   └── 📜 __all__: make_scanner
-└── 📦 tool
-    └── ⚡ functions: main
-
-» uvx pretty-mod sig fastmcp:FastMCP
-📎 FastMCP
-├── Parameters:
-├── name: str | None=None
-├── instructions: str | None=None
-├── auth: OAuthProvider | None=None
-├── lifespan: Callable[[FastMCP[LifespanResultT]], AbstractAsyncContextManager[LifespanResultT]] | None=None
-├── tags: set[str] | None=None
-├── dependencies: list[str] | None=None
-├── tool_serializer: Callable[[Any], str] | None=None
-├── cache_expiration_seconds: float | None=None
-├── on_duplicate_tools: DuplicateBehavior | None=None
-├── on_duplicate_resources: DuplicateBehavior | None=None
-├── on_duplicate_prompts: DuplicateBehavior | None=None
-├── resource_prefix_format: Literal['protocol', 'path'] | None=None
-├── mask_error_details: bool | None=None
-├── tools: list[Tool | Callable[..., Any]] | None=None
-└── **settings: Any
-```
-
-## Installation
-
-```bash
-uv add pretty-mod
-```
-
-## Usage
-
-```python
-from pretty_mod import display_tree
-
-# Explore a module structure  
-display_tree("collections", max_depth=2)
-```
-
-<details>
-<summary>Example output</summary>
-
-```text
-display_tree("collections", max_depth=2)
-
-📦 collections
-├── 📜 __all__: ChainMap, Counter, OrderedDict, UserDict, UserList, UserString, defaultdict, deque, namedtuple
-├── 🔷 classes: ChainMap, Counter, OrderedDict, UserDict, UserList, UserString, defaultdict, deque
-├── ⚡ functions: namedtuple
-└── 📦 abc
-    ├── 📜 __all__: Awaitable, Coroutine, AsyncIterable, AsyncIterator, AsyncGenerator, Hashable, Iterable, Iterator, Generator, Reversible, Sized, Container, Callable, Collection, Set, MutableSet, Mapping, MutableMapping, MappingView, KeysView, ItemsView, ValuesView, Sequence, MutableSequence, ByteString, Buffer
-    └── 🔷 classes: AsyncGenerator, AsyncIterable, AsyncIterator, Awaitable, Buffer, ByteString, Callable, Collection, Container, Coroutine, Generator, Hashable, ItemsView, Iterable, Iterator, KeysView, Mapping, MappingView, MutableMapping, MutableSequence, MutableSet, Reversible, Sequence, Set, Sized, ValuesView
-```
-</details>
-
-
-
-```python
-from pretty_mod import display_signature
-
-# Display the signature of a callable (function, class constructor, etc.)
-print(display_signature("json:loads"))
-```
-
-<details>
-<summary>Example output</summary>
-
-```text
-📎 loads
-├── Parameters:
-├── s
-├── *
-├── cls=None
-├── object_hook=None
-├── parse_float=None
-├── parse_int=None
-├── parse_constant=None
-├── object_pairs_hook=None
-└── **kw
-```
-</details>
-
-## CLI
-
-Pretty-mod includes a command-line interface for quick exploration:
-
-```bash
-# Explore module structure
-pretty-mod tree json
-
-# Go deeper into the tree with --depth
-pretty-mod tree requests --depth 3
-
-# Display function signatures  
-pretty-mod sig json:loads
-pretty-mod sig os.path:join
-
-# Explore packages even without having them installed
-pretty-mod tree django
-pretty-mod tree flask --depth 1
-
-# Use --quiet to suppress download messages when you don't have the package installed
-pretty-mod tree requests --quiet
-```
-
-## Examples
-
-See the [`examples/`](examples/) directory for more detailed usage patterns and advanced features.
-
-## Development
-
-```bash
-gh repo clone zzstoatzz/pretty-mod && cd pretty-mod
-just --list # see https://github.com/casey/just
-```
-
-<details>
-<summary>Performance Testing</summary>
-
-The performance test script (`scripts/perf_test.py`) supports both single-run exploration and proper benchmarking with multiple iterations:
-
-```bash
-# Run a proper benchmark with multiple iterations
-./scripts/perf_test.py json --benchmark
-./scripts/perf_test.py urllib --benchmark --runs 100 --warmup 10
-
-# Compare performance between local and published versions
-just compare-perf prefect 2
-
-# Benchmark multiple modules
-just benchmark-modules
-
-# Or use shell timing for quick single-run comparisons
-time ./scripts/perf_test.py numpy --depth 3
-time uvx pretty-mod tree numpy --depth 3
-```
-
-Benchmark mode provides:
-- Warmup runs to account for cold starts
-- Multiple iterations for statistical significance
-- Mean, standard deviation, min/max timing statistics
-- Silent operation (no tree output) for accurate timing
-
-</details>

pretty_mod-0.1.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-pretty_mod-0.1.1.dist-info/METADATA,sha256=movybNjG8J0NDjqlx5jP-aa3zs_qBCykpWBjGSJbgZQ,5533
-pretty_mod-0.1.1.dist-info/WHEEL,sha256=aBacha0FcFMzjQuVTMCEUEJSXL9SWMbeMaJPxWjGHqE,92
-pretty_mod-0.1.1.dist-info/entry_points.txt,sha256=aNlomjGTypAOUeZiSZ4OYFY-QVq2KmDXkO9QFS45uW4,49
-pretty_mod-0.1.1.dist-info/licenses/LICENSE,sha256=J2cPHis9ZpzSonH9dVASFNtKrAdQmI-6qYBlivuubwA,1087
-pretty_mod/__init__.py,sha256=FWM2poN7eHWyVNly7AqU0RJlDHCrxhnk_k6LPFgyXcc,106
-pretty_mod/_pretty_mod.cp310-win32.pyd,sha256=uLjX40FPotBBgBJ0YewElJEX7qMleoYkyqynnrGgr3Q,5196288
-pretty_mod/_pretty_mod.pyi,sha256=BrQWGKmO3EgJvZkVI59zHRySbSy1snZpAhXc7LioXAc,661
-pretty_mod/cli.py,sha256=6-omiKcG5bDeDI696l6Lr7_vnpnMzsjxoz7c8g-j_oc,1525
-pretty_mod/explorer.py,sha256=3w-oY7edQzQMlAOVUSBqPJ94tiuJZXc45yD9bDHFsTs,268
-pretty_mod/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pretty_mod-0.1.1.dist-info/RECORD,,