Metadata-Version: 2.4
Name: threadline-review
Version: 0.2.0b3
Summary: Visual, source-backed review of Python workflows before execution
Author: Threadline contributors
License: MIT License
        
        Copyright (c) 2026 Threadline contributors
        
        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.
        
Project-URL: Homepage, https://github.com/Raman369AI/threadline
Project-URL: Documentation, https://github.com/Raman369AI/threadline/tree/main/docs
Project-URL: Repository, https://github.com/Raman369AI/threadline
Project-URL: Issues, https://github.com/Raman369AI/threadline/issues
Keywords: python,static-analysis,code-review,visualization
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: browser-test
Requires-Dist: websocket-client<2,>=1.7; extra == "browser-test"
Requires-Dist: selenium<5,>=4.35; extra == "browser-test"
Provides-Extra: typecheck
Requires-Dist: mypy<2,>=1.16; extra == "typecheck"
Dynamic: license-file

# Threadline

**Follow data through Python methods, with source and model definitions beside it.**

[Get started](https://github.com/Raman369AI/threadline/blob/main/docs/USING_THREADLINE.md) · [Documentation](https://github.com/Raman369AI/threadline/blob/main/docs/README.md) · [GitHub](https://github.com/Raman369AI/threadline) · [Report a bug](https://github.com/Raman369AI/threadline/issues)

Threadline opens your Python repository in a local browser. Choose an endpoint,
command, or method to see what data enters it, what it creates or changes, and
where values are used or returned. Follow calls across methods while keeping
the original code and model declarations close by.

It reads source without importing or running the project being reviewed. That project's dependencies do not need to be installed.

## Install and open a repository

Requires **Python 3.12 or later**. In your Python environment:

```bash
python -m pip install --pre threadline-review
threadline review /path/to/your/python-project
```

Your browser opens the review automatically. If it does not, open the local address printed in the terminal. For virtual-environment setup, see the [installation guide](https://github.com/Raman369AI/threadline/blob/main/docs/USING_THREADLINE.md#install-from-pypi).

## Choose where to start

| Page | How to use it |
| --- | --- |
| **Endpoints** | Pick an HTTP verb tab, such as GET or POST, then an endpoint. |
| **Commands & tasks** | Select a CLI command or background task. |
| **Modules & methods** | Pick a module, filter its methods, then select one. |

Search is available across all three pages. Selecting a method opens its Data
flow beside its Data models; nothing is selected automatically. Switch to Steps
for the line-by-line explanation or expand Code to read only the selected
method. The code pane can also sit beside the analysis at an adjustable width.
Related tests expand below the code. Selecting a caller compares both methods'
code and flow side by side, with Back returning to your previous view.

Each data link points to source evidence. Unresolved sources and effects remain
visible as gaps rather than invented values. The [usage guide](https://github.com/Raman369AI/threadline/blob/main/docs/USING_THREADLINE.md)
explains model references, navigation, and the limits of static data flow.

## Review a change

Compare a working tree with a Git baseline:

```bash
threadline review /path/to/your/python-project --base HEAD
```

Open **Changes** to select a changed method or compare its before/after source. Changed
files, rename-only records, and edits outside methods remain visible when no callable
body changes. Current callers, historical callers, and possible impact are shown
separately. These are direct source relationships, not a complete impact analysis.

For source roots, exclusions, snapshot-pinned JSON queries, and evidence retrieval, see
the [usage guide](https://github.com/Raman369AI/threadline/blob/main/docs/USING_THREADLINE.md).

## Understand the limits

Threadline uses static analysis. The browser labels each call **Calls**, **Probably
calls**, **Library**, or **Can't tell** according to the source evidence (`supported`,
`possible`, `external`, and `unknown` in JSON output). Common injected,
inherited, and constructed receivers can have possible source candidates. Dynamic
dispatch can remain unresolved; the view does not establish what happened at runtime.
The header shows analysis problems, and **Coverage** lists parse failures and unmodeled
syntax.

This is a **beta**. Linux and macOS are tested with Python 3.12–3.14; Windows is experimental. Human reviewer sessions remain pending before a stable release.

- [Capabilities and limits](https://github.com/Raman369AI/threadline/blob/main/docs/CAPABILITIES.md)
- [Validation and platform coverage](https://github.com/Raman369AI/threadline/blob/main/docs/VALIDATION.md)
- [Keyboard access and accessibility](https://github.com/Raman369AI/threadline/blob/main/docs/ACCESSIBILITY.md)
- [Changelog](https://github.com/Raman369AI/threadline/blob/main/CHANGELOG.md)

## Contribute

See the [contributor guide](https://github.com/Raman369AI/threadline/blob/main/CONTRIBUTING.md) for development and testing, and the [publishing guide](https://github.com/Raman369AI/threadline/blob/main/docs/PUBLISHING.md) for releases.

[MIT License](https://github.com/Raman369AI/threadline/blob/main/LICENSE) · [Security policy](https://github.com/Raman369AI/threadline/blob/main/SECURITY.md)
