Metadata-Version: 2.4
Name: threadlepy
Version: 0.1.2
Summary: Python client for the Threadle CLI JSON interface.
Author: Yukun Jiao
License-Expression: MIT
Project-URL: Homepage, https://github.com/YukunJiao/threadlepy
Project-URL: Issues, https://github.com/YukunJiao/threadlepy/issues
Project-URL: Documentation, https://github.com/YukunJiao/threadlepy#readme
Project-URL: Source, https://github.com/YukunJiao/threadlepy
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# threadlepy

Python client for the Threadle CLI JSON interface.

`threadlepy` starts a Threadle subprocess and exposes Python wrappers for core Threadle workflows.

## Installation

```bash
pip install threadlepy
```

Requirements:

- Python 3.9+
- A working `threadle` executable available on `PATH`

## Quick Start

```python
import threadlepy
import threadlepy.commands as th

with threadlepy.session(timeout=3600):
    examples = th.load_examples("lazega")
    lazega = examples["lazega"]

    print(th.info(lazega))

    path = th.shortest_path(
        lazega,
        node1id=1,
        node2id=23,
        layernames="friends",
    )

    print(path)
```

If `threadle` is not on `PATH`, pass the executable path explicitly:

```python
threadlepy.start("/full/path/to/threadle")
```

## Documentation

For more examples and workflows, see:

```text
docs/threadlepy_tutorial.ipynb
```
