Metadata-Version: 2.1
Name: touchpy
Version: 0.12.0
Summary: TouchPy is a high-performance toolset to work with TouchDesigner components in Python
Author-Email: Keith Lostracco <keith@intentdev.io>
License: # PolyForm Noncommercial License 1.0.0
         
         <https://polyformproject.org/licenses/noncommercial/1.0.0>
         
         ## Acceptance
         
         In order to get any license under these terms, you must agree
         to them as both strict obligations and conditions to all
         your licenses.
         
         ## Copyright License
         
         The licensor grants you a copyright license for the
         software to do everything you might do with the software
         that would otherwise infringe the licensor's copyright
         in it for any permitted purpose.  However, you may
         only distribute the software according to [Distribution
         License](#distribution-license) and make changes or new works
         based on the software according to [Changes and New Works
         License](#changes-and-new-works-license).
         
         ## Distribution License
         
         The licensor grants you an additional copyright license
         to distribute copies of the software.  Your license
         to distribute covers distributing the software with
         changes and new works permitted by [Changes and New Works
         License](#changes-and-new-works-license).
         
         ## Notices
         
         You must ensure that anyone who gets a copy of any part of
         the software from you also gets a copy of these terms or the
         URL for them above, as well as copies of any plain-text lines
         beginning with `Required Notice:` that the licensor provided
         with the software.  For example:
         
         > Required Notice: Intent Productions, Inc. (http://intentdev.io)
         
         ## Changes and New Works License
         
         The licensor grants you an additional copyright license to
         make changes and new works based on the software for any
         permitted purpose.
         
         ## Patent License
         
         The licensor grants you a patent license for the software that
         covers patent claims the licensor can license, or becomes able
         to license, that you would infringe by using the software.
         
         ## Noncommercial Purposes
         
         Any noncommercial purpose is a permitted purpose.
         
         ## Personal Uses
         
         Personal use for research, experiment, and testing for
         the benefit of public knowledge, personal study, private
         entertainment, hobby projects, amateur pursuits, or religious
         observance, without any anticipated commercial application,
         is use for a permitted purpose.
         
         ## Noncommercial Organizations
         
         Use by any charitable organization, educational institution,
         public research organization, public safety or health
         organization, environmental protection organization,
         or government institution is use for a permitted purpose
         regardless of the source of funding or obligations resulting
         from the funding.
         
         ## Fair Use
         
         You may have "fair use" rights for the software under the
         law. These terms do not limit them.
         
         ## No Other Rights
         
         These terms do not allow you to sublicense or transfer any of
         your licenses to anyone else, or prevent the licensor from
         granting licenses to anyone else.  These terms do not imply
         any other licenses.
         
         ## Patent Defense
         
         If you make any written claim that the software infringes or
         contributes to infringement of any patent, your patent license
         for the software granted under these terms ends immediately. If
         your company makes such a claim, your patent license ends
         immediately for work on behalf of your company.
         
         ## Violations
         
         The first time you are notified in writing that you have
         violated any of these terms, or done anything with the software
         not covered by your licenses, your licenses can nonetheless
         continue if you come into full compliance with these terms,
         and take practical steps to correct past violations, within
         32 days of receiving notice.  Otherwise, all your licenses
         end immediately.
         
         ## No Liability
         
         ***As far as the law allows, the software comes as is, without
         any warranty or condition, and the licensor will not be liable
         to you for any damages arising out of these terms or the use
         or nature of the software, under any kind of legal claim.***
         
         ## Definitions
         
         The **licensor** is the individual or entity offering these
         terms, and the **software** is the software the licensor makes
         available under these terms.
         
         **You** refers to the individual or entity agreeing to these
         terms.
         
         **Your company** is any legal entity, sole proprietorship,
         or other kind of organization that you work for, plus all
         organizations that have control over, are under the control of,
         or are under common control with that organization.  **Control**
         means ownership of substantially all the assets of an entity,
         or the power to direct its management and policies by vote,
         contract, or otherwise.  Control can be direct or indirect.
         
         **Your licenses** are all the licenses granted to you for the
         software under these terms.
         
         **Use** means anything you do with the software requiring one
         of your licenses.
         
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
```
