Metadata-Version: 2.4
Name: devwayfinder
Version: 0.3.10
Summary: AI-Powered Developer Onboarding Generator
Author: IMAGINARY9
License-Expression: MIT
Project-URL: Homepage, https://github.com/IMAGINARY9/DevWayfinder
Project-URL: Repository, https://github.com/IMAGINARY9/DevWayfinder
Project-URL: Documentation, https://github.com/IMAGINARY9/DevWayfinder#readme
Project-URL: Issues, https://github.com/IMAGINARY9/DevWayfinder/issues
Keywords: onboarding,documentation,code-analysis,developer-tools,llm,ai
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.9.0
Requires-Dist: rich>=13.0.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: pydantic-settings>=2.0.0
Requires-Dist: httpx>=0.25.0
Requires-Dist: aiofiles>=23.0.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: tomli>=2.0.0; python_version < "3.11"
Requires-Dist: networkx>=3.0
Requires-Dist: gitpython>=3.1.0
Requires-Dist: pathspec>=0.11.0
Provides-Extra: dev
Requires-Dist: pytest>=7.4.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
Requires-Dist: pytest-mock>=3.11.0; extra == "dev"
Requires-Dist: respx>=0.20.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: mypy>=1.5.0; extra == "dev"
Requires-Dist: types-pyyaml>=6.0.0; extra == "dev"
Requires-Dist: types-aiofiles>=23.0.0; extra == "dev"
Provides-Extra: tree-sitter
Requires-Dist: tree-sitter>=0.20.0; extra == "tree-sitter"
Requires-Dist: tree-sitter-python>=0.20.0; extra == "tree-sitter"
Requires-Dist: tree-sitter-typescript>=0.20.0; extra == "tree-sitter"
Requires-Dist: tree-sitter-javascript>=0.20.0; extra == "tree-sitter"
Provides-Extra: all
Requires-Dist: tree-sitter>=0.20.0; extra == "all"
Requires-Dist: tree-sitter-python>=0.20.0; extra == "all"
Requires-Dist: tree-sitter-typescript>=0.20.0; extra == "all"
Requires-Dist: tree-sitter-javascript>=0.20.0; extra == "all"
Requires-Dist: pytest>=7.4.0; extra == "all"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "all"
Requires-Dist: pytest-cov>=4.1.0; extra == "all"
Requires-Dist: pytest-mock>=3.11.0; extra == "all"
Requires-Dist: respx>=0.20.0; extra == "all"
Requires-Dist: ruff>=0.1.0; extra == "all"
Requires-Dist: mypy>=1.5.0; extra == "all"
Requires-Dist: types-pyyaml>=6.0.0; extra == "all"
Requires-Dist: types-aiofiles>=23.0.0; extra == "all"
Dynamic: license-file

# DevWayfinder

AI-powered developer onboarding guide generator.

## Quick Start

### 1. Install (from source)

```bash
git clone https://github.com/IMAGINARY9/DevWayfinder.git
cd DevWayfinder
python -m venv .venv
# Windows PowerShell
.\.venv\Scripts\Activate.ps1
pip install -e ".[dev]"
```

### 2. Verify Provider (optional)

```bash
devwayfinder test-model --provider ollama --model mistral:7b
```

### 3. Generate Guide

```bash
devwayfinder guide ./my-project --auto
# quick offline mode:
# devwayfinder guide ./my-project --quality minimal --no-llm
```

---

## Core Commands

- `devwayfinder analyze <path>`
- `devwayfinder guide <path>`
- `devwayfinder generate <path>`
- `devwayfinder test-model`
- `devwayfinder init`

---

## Status

- MVP 1: complete
- MVP 2: complete
- MVP 2.5: complete
- MVP 3: in progress

See roadmap details in [docs/IMPLEMENTATION_PLAN.md](docs/IMPLEMENTATION_PLAN.md).

---

## Documentation (Authoritative)

- Architecture: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)
- Requirements: [docs/REQUIREMENTS.md](docs/REQUIREMENTS.md)
- Roadmap and milestone status: [docs/IMPLEMENTATION_PLAN.md](docs/IMPLEMENTATION_PLAN.md)
- Configuration: [docs/CONFIGURATION.md](docs/CONFIGURATION.md)
- Provider setup and runtime usage: [docs/USAGE.md](docs/USAGE.md)
- Development and contribution standards: [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md)
- Performance benchmarks: [docs/PERFORMANCE.md](docs/PERFORMANCE.md)

---

## License

MIT - see [LICENSE](LICENSE).
