Metadata-Version: 2.1
Name: touchpy
Version: 0.12.1
Summary: TouchPy is a high-performance toolset to work with TouchDesigner components in Python
Author-Email: Keith Lostracco <keith@intentdev.io>
License: MIT License
         
         Copyright (c) 2024-2026 Intent Productions, Inc.
         
         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: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: Microsoft :: Windows
Project-URL: Documentation, https://intentdev.github.io/touchpy/
Project-URL: GitHub, https://github.com/IntentDev/touchpy
Requires-Python: <3.15,>=3.9
Provides-Extra: examples
Requires-Dist: torch; extra == "examples"
Requires-Dist: torchvision; extra == "examples"
Requires-Dist: numpy; extra == "examples"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: furo; extra == "dev"
Requires-Dist: sphinx-autoapi; extra == "dev"
Description-Content-Type: text/markdown

[![PyPI version](https://badge.fury.io/py/touchpy.svg)](https://badge.fury.io/py/touchpy)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/touchpy)](https://pypi.org/project/touchpy/)

# TouchPy

TouchPy is a high-performance Python toolset for working with TouchDesigner components headlessly via the TouchEngine SDK. It provides GPU-accelerated data exchange (CUDA/Vulkan) for TOPs, CHOPs, DATs, and parameters.

## Requirements

- Windows 10/11 (x64)
- [TouchDesigner](https://derivative.ca/download) installed (runtime dependency)
- NVIDIA GPU with CUDA support
- Python 3.9 - 3.14 (3.12 recommended for development)

## Installation

If you simply want to use TouchPy and run the examples, you don't need to clone this repo:

```bash
uv add touchpy[examples]
```

This installs TouchPy with CUDA-enabled PyTorch and numpy for running the examples.

> [uv](https://docs.astral.sh/uv/) is required for dependency management. Install it via `pip install uv` or see the [uv docs](https://docs.astral.sh/uv/getting-started/installation/).

## Quick Start

```python
import touchpy as tp

comp = tp.Comp()
comp.load("path/to/component.tox")
comp.start()

if comp.frame_did_finish():
    comp.start_next_frame()
```

See the `examples/` directory for more detailed usage including TOPs with PyTorch tensors, CHOPs, DATs, and parameter control.

## Documentation

Full API documentation is available at [intentdev.github.io/touchpy](https://intentdev.github.io/touchpy/).

---

## Development

### Prerequisites

- [Visual Studio 2022](https://visualstudio.microsoft.com/) with C++ desktop workload
- [CMake](https://cmake.org/) 3.21+
- [CUDA Toolkit](https://developer.nvidia.com/cuda-toolkit) 12.x
- [Vulkan SDK](https://vulkan.lunarg.com/)
- [uv](https://docs.astral.sh/uv/) for Python dependency management

### Setup

```bash
git clone --recurse-submodules https://github.com/IntentDev/touchpy.git
cd touchpy
uv venv --python 3.12
uv sync --extra examples
```

If you already cloned without `--recurse-submodules`:

```bash
git submodule update --init
```

This creates a `.venv` with Python 3.12, builds TouchPy from source (via scikit-build-core), and installs CUDA-enabled PyTorch + numpy for running examples.

> **Note:** Python 3.12 is recommended. PyTorch wheels for 3.13+ may have packaging issues.

### Rebuilding after C++ changes

```bash
uv sync --extra examples --reinstall-package touchpy
```

Or equivalently:

```bash
uv pip install -ve .
```

### Build a wheel

```bash
uv build
```

### Verify

```python
import touchpy
print(touchpy.__version__)  # shows 0.12.0.dev0 for local dev builds
```
