Metadata-Version: 2.3
Name: pathwright
Version: 0.1.0
Summary: Python filesystem operations toolkit with CLI and MCP server for AI integrations
Keywords: filesystem,mcp,model-context-protocol,cli,ai,llm,file-management
Author: Sergei Konovalov
Author-email: Sergei Konovalov <l0kifs91@gmail.com>
License: MIT License
         
         Copyright (c) 2026 Sergei Konovalov
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
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.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Filesystems
Classifier: Topic :: Utilities
Requires-Dist: pydantic-settings>=2.0.0
Requires-Dist: structlog>=25.1.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: fastmcp>=2.0.0
Requires-Dist: typer>=0.12.0
Requires-Dist: rich>=13.7.0
Requires-Python: >=3.11
Project-URL: Homepage, https://github.com/l0kifs/pathwright
Project-URL: Repository, https://github.com/l0kifs/pathwright
Project-URL: Issues, https://github.com/l0kifs/pathwright/issues
Description-Content-Type: text/markdown

# pathwright

Pathwright is a Python filesystem operations toolkit with two entry points:
- CLI for terminal workflows
- MCP server for AI model integrations

Detailed usage reference: [docs/REFERENCE.md](docs/REFERENCE.md)

## Installation

```bash
uv sync --all-groups
```

## CLI

Run with:

```bash
uv run pathwright --help
```

Supported command groups:
- `create-files`, `read-files`, `update-files`, `delete-files`
- `search-files`, `transfer-files`
- `create-dirs`, `read-dirs`, `update-dirs`, `delete-dirs`
- `search-dirs`, `transfer-dirs`
- `fs-outline`, `files-outline`

Examples:

```bash
uv run pathwright create-files --item "tmp/a.txt::hello"
uv run pathwright read-files --path "tmp/a.txt"
uv run pathwright search-files --base-path . --extension py --name-pattern "*.py"
uv run pathwright fs-outline --base-path . --depth 2
```

## MCP Server

Run with:

```bash
uv run pathwright-mcp
```

Exposed tools map to the same filesystem operations as CLI:
- `create_files`, `read_files`, `update_files`, `delete_files`
- `search_files`, `copy_or_move_files`
- `create_directories`, `read_directories`, `update_directories`, `delete_directories`
- `search_directories`, `copy_or_move_directories`
- `filesystem_outline`, `files_outline`

## Testing

Run feature-organized end-to-end suites:

```bash
uv run pytest --maxfail=1 --tb=short
```
