pretty-mod 0.1.2__cp311-cp311-macosx_11_0_arm64.whl → 0.2.0__cp311-cp311-macosx_11_0_arm64.whl

{pretty_mod-0.1.2.dist-info → pretty_mod-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pretty-mod
-Version: 0.1.2
+Version: 0.2.0
 License-File: LICENSE
 Summary: A python module tree explorer for LLMs (and humans)
 Author-email: zzstoatzz <thrast36@gmail.com>
@@ -15,6 +15,9 @@ 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
@@ -32,57 +35,85 @@ a python module tree explorer for LLMs (and humans)
 └── 📦 tool
     └── ⚡ functions: main
 
-# Inspect function signatures
-» uvx pretty-mod sig json:dumps
-📎 dumps
-├── Parameters:
-├── obj
-├── *
-├── skipkeys=False
-├── ensure_ascii=True
-├── check_circular=True
-├── allow_nan=True
-├── cls=None
-├── indent=None
-├── separators=None
-├── default=None
-├── sort_keys=False
-└── **kw
-
-# Auto-download packages from PyPI (no install needed!)
-» uvx pretty-mod tree requests --quiet
-📦 requests
-├── 📜 __all__: delete, get, head, options, patch, post, put, request
-├── ⚡ functions: check_compatibility, delete, get, head, options, patch, post, put, request
-├── 🔷 classes: ConnectTimeout, ConnectionError, DependencyWarning, FileModeWarning, HTTPError, JSONDecodeError, NullHandler, PreparedRequest, ReadTimeout, Request, RequestException, RequestsDependencyWarning, Response, Session, Timeout, TooManyRedirects, URLRequired
-├── 📌 constants: __author__, __author_email__, __build__, __cake__, __copyright__, __description__, __license__, __title__, __url__, codes
-├── 📦 adapters
-│   ├── 🔷 classes: BaseAdapter, HTTPAdapter
-│   └── 📌 constants: DEFAULT_POOL_TIMEOUT, DEFAULT_POOLBLOCK, DEFAULT_POOLSIZE, DEFAULT_RETRIES
-├── 📦 api
-│   └── ⚡ functions: delete, get, head, options, patch, post, put, request
-├── 📦 auth
-│   └── 🔷 classes: AuthBase, HTTPBasicAuth, HTTPDigestAuth, HTTPProxyAuth
-├── 📦 certs
-├── 📦 compat
-├── 📦 cookies
-├── 📦 exceptions
-├── 📦 help
-├── 📦 hooks
-├── 📦 models
-├── 📦 sessions
-├── 📦 status_codes
-├── 📦 structures
-└── 📦 utils
+# 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
+## installation
 
 ```bash
 uv add pretty-mod
 ```
 
-## Usage
+
+## 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
@@ -134,45 +165,55 @@ print(display_signature("json:loads"))
 ```
 </details>
 
-## CLI
+## customization
 
-Pretty-mod includes a command-line interface for quick exploration:
+pretty-mod supports extensive customization through environment variables:
 
-> [!IMPORTANT]
-> all commands below can be run ephemerally with `uvx`, e.g. `uvx pretty-mod tree json`
+### display characters
 
 ```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
+# Use ASCII-only mode for terminals without Unicode support
+PRETTY_MOD_ASCII=1 pretty-mod tree json
 
-# Explore packages even without having them installed
-pretty-mod tree django
-pretty-mod tree flask --depth 1
+# 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
+```
 
-# Use --quiet to suppress download messages
-pretty-mod tree requests --quiet
+### colors
 
-# Version specifiers - explore specific versions
-pretty-mod tree toml@0.10.2
-pretty-mod sig toml@0.10.2:loads
+pretty-mod uses an earth-tone color scheme by default:
 
-# 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
+```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
 ```
 
-## Examples
+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.
+see the [`examples/`](examples/) directory for more detailed usage patterns and advanced features.
 
-## Development
+## development
 
 ```bash
 gh repo clone zzstoatzz/pretty-mod && cd pretty-mod

{pretty_mod-0.1.2.dist-info → pretty_mod-0.2.0.dist-info}/RECORD

@@ -1,11 +1,11 @@
-pretty_mod-0.1.2.dist-info/METADATA,sha256=qMNGAxnmLoRU8k8hbfaCP-pkJxcmXphn6EyqM2lfJnY,6599
-pretty_mod-0.1.2.dist-info/WHEEL,sha256=8hL2oHqulIPF_TJ_OfB-8kD2X9O6HJL0emTmeguFbqc,104
-pretty_mod-0.1.2.dist-info/entry_points.txt,sha256=aNlomjGTypAOUeZiSZ4OYFY-QVq2KmDXkO9QFS45uW4,49
-pretty_mod-0.1.2.dist-info/licenses/LICENSE,sha256=t4-aJACJSRrl4B6UnAoE9JRQY_uacSfllsrgf0ezefo,1067
+pretty_mod-0.2.0.dist-info/METADATA,sha256=vuwrFXS05ULYzy_zoaE2lmbqNmz9Lg6iiXX3nfwNHSo,8277
+pretty_mod-0.2.0.dist-info/WHEEL,sha256=8hL2oHqulIPF_TJ_OfB-8kD2X9O6HJL0emTmeguFbqc,104
+pretty_mod-0.2.0.dist-info/entry_points.txt,sha256=aNlomjGTypAOUeZiSZ4OYFY-QVq2KmDXkO9QFS45uW4,49
+pretty_mod-0.2.0.dist-info/licenses/LICENSE,sha256=t4-aJACJSRrl4B6UnAoE9JRQY_uacSfllsrgf0ezefo,1067
 pretty_mod/__init__.py,sha256=jVcaTvbU6PZ2b_el4hnF_mmc-thfDOpTvePOS3n4D9c,103
-pretty_mod/_pretty_mod.cpython-311-darwin.so,sha256=iHAV7qJ5E4H-siItKqeYRtbNwq_w9m98c28lGbCycR4,6236480
+pretty_mod/_pretty_mod.cpython-311-darwin.so,sha256=KKmRsSPlVkTwY3Ws2Xx333hAs0wyGDFW3cqJFv5ImcY,6270352
 pretty_mod/_pretty_mod.pyi,sha256=OQs08-sWtiBpXJJvmkue80v5x3rYIsGocQKx6osMRZw,662
 pretty_mod/cli.py,sha256=pehQfJ3KKrv0KRaU9JtTtl3x84wRDCyU-5mEPjVKbcA,1610
 pretty_mod/explorer.py,sha256=dWSZi4QH-JvhF8AlKcfpDOrx3-ijsHhhn8tcEsRPYH8,258
 pretty_mod/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pretty_mod-0.1.2.dist-info/RECORD,,
+pretty_mod-0.2.0.dist-info/RECORD,,