tdfw 0.1.1__tar.gz

tdfw-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MichaelKramerGuitar
+
+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.

tdfw-0.1.1/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.4
+Name: tdfw
+Version: 0.1.1
+Summary: TouchDesigner Framework CLI scaffold tool for opinionated State Driven Command and Control/Code Driven project architecture
+Author-email: Michael Kramer <michael.kramer.guitar@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/MichaelKramerGuitar/tdfw
+Project-URL: Repository, https://github.com/MichaelKramerGuitar/tdfw
+Project-URL: Issues, https://github.com/MichaelKramerGuitar/tdfw/issues
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Dynamic: license-file
+
+![Coverage](https://codecov.io/gh/MichaelKramerGuitar/tdfw/branch/main/graph/badge.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
+
+
+# tdfw
+TouchDesigner Framework CLI scaffold tool with an opinionated slant towards State Driven/Code Driven project architecture.
+
+## About
+
+Hi, I'm Michael. I play guitar and write code. I was introduced to TouchDesigner by my friend Andrew Zolty, who's also known as `BREAKFAST`. He's an incredible kinetic artist. 
+
+Getting started with TouchDesigner as a GUI never really happened for me. I started a few YouTube courses on it but didn't have the time to follow through and learn how to use the interface. 
+
+But the concept of a network of nodes and subnodes made sense to my programmer/software engineer brain. I thought "there must be a purely code driven way to architect these TouchDesinger apps". So I looked on YouTube and found [this](https://www.youtube.com/watch?v=nQT7EhYCVg0) video (read more about that in [BACKGROUND.md](./BACKGROUND.md)). I was thrilled and what has resulted is essentially this tool which abstracts out all the boilerplate he gives. 
+
+# How To Use
+
+```bash
+# Install 
+uv pip install tdfw
+
+# Confirm installation and check options
+tdfw help
+
+# Start a TouchDesigner App
+tdfw start-app <MyFirstApp>
+
+# Create a Python Extension stub (from your TouchDesigner Project Root i.e. the dir with the <MyFirstApp>.toe file)
+tdfw create-ext <MyFirstExt>
+```

tdfw-0.1.1/README.md

@@ -0,0 +1,29 @@
+![Coverage](https://codecov.io/gh/MichaelKramerGuitar/tdfw/branch/main/graph/badge.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
+
+
+# tdfw
+TouchDesigner Framework CLI scaffold tool with an opinionated slant towards State Driven/Code Driven project architecture.
+
+## About
+
+Hi, I'm Michael. I play guitar and write code. I was introduced to TouchDesigner by my friend Andrew Zolty, who's also known as `BREAKFAST`. He's an incredible kinetic artist. 
+
+Getting started with TouchDesigner as a GUI never really happened for me. I started a few YouTube courses on it but didn't have the time to follow through and learn how to use the interface. 
+
+But the concept of a network of nodes and subnodes made sense to my programmer/software engineer brain. I thought "there must be a purely code driven way to architect these TouchDesinger apps". So I looked on YouTube and found [this](https://www.youtube.com/watch?v=nQT7EhYCVg0) video (read more about that in [BACKGROUND.md](./BACKGROUND.md)). I was thrilled and what has resulted is essentially this tool which abstracts out all the boilerplate he gives. 
+
+# How To Use
+
+```bash
+# Install 
+uv pip install tdfw
+
+# Confirm installation and check options
+tdfw help
+
+# Start a TouchDesigner App
+tdfw start-app <MyFirstApp>
+
+# Create a Python Extension stub (from your TouchDesigner Project Root i.e. the dir with the <MyFirstApp>.toe file)
+tdfw create-ext <MyFirstExt>
+```

tdfw-0.1.1/pyproject.toml

@@ -0,0 +1,41 @@
+[project]
+name = "tdfw"
+version = "0.1.1"
+description = "TouchDesigner Framework CLI scaffold tool for opinionated State Driven Command and Control/Code Driven project architecture"
+authors = [{ name = "Michael Kramer", email = "michael.kramer.guitar@gmail.com" }]
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.9"
+dependencies = ["click"]
+
+[dependency-groups]
+dev = ["pytest", "pytest-cov", "twine"]
+
+[project.urls]
+Homepage = "https://github.com/MichaelKramerGuitar/tdfw"
+Repository = "https://github.com/MichaelKramerGuitar/tdfw"
+Issues = "https://github.com/MichaelKramerGuitar/tdfw/issues"
+
+[project.scripts]
+tdfw = "tdfw.cli:cli"
+
+[tool.setuptools]
+packages = ["tdfw"]
+
+[tool.uv]
+default-groups = ["dev"]
+
+[tool.pytest.ini_options]
+addopts = "--cov=tdfw --cov-report=xml --cov-report=term-missing"
+
+[tool.coverage.run]
+branch = true
+omit = [
+    "*/__init__.py",
+    "tests/*"
+]
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+

tdfw-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tdfw-0.1.1/tdfw/cli.py

@@ -0,0 +1,201 @@
+import os
+import click
+import subprocess
+import shutil
+
+def check_tool(tool_name):
+    """Return True if tool is available in PATH"""
+    return shutil.which(tool_name) is not None
+
+def ensure_dir(path):
+    if not os.path.exists(path):
+        os.makedirs(path)
+
+@click.group()
+def cli():
+    """TouchDesigner Framework CLI (tdfw)"""
+    pass
+
+# ----------------------------
+# App scaffolding
+# ----------------------------
+@click.command()
+@click.argument("app_name")
+@click.option("--td-path", default=None,
+              help="Override path to TouchDesigner executable")
+def start_app(app_name, td_path):
+    """Scaffold a new TouchDesigner app"""
+    base = os.path.abspath(app_name)
+    ensure_dir(base)
+
+    for folder in ["BAT", "DAT", "LOG"]:
+        ensure_dir(os.path.join(base, folder))
+
+    with open(os.path.join(base, "README.md"), "w") as f:
+        f.write(f"# {app_name}\nGenerated by tdfw\n")
+
+    with open(os.path.join(base, ".gitignore"), "w") as f:
+        f.write("*.toe\n*.log\n")
+
+    # Default TD path
+    default_td_path = "C:\\Program Files\\Derivative\\TouchDesigner\\bin\\TouchDesigner.exe"
+    td_exec = td_path if td_path else default_td_path
+
+    # Windows .bat
+    bat_path = os.path.join(base, "BAT", f"{os.path.basename(app_name)}.bat")
+    with open(bat_path, "w") as f:
+        f.write(f"""@echo off
+set NODE=DEV
+start "" "{td_exec}" "{app_name}.toe"
+""")
+
+    # Mac/Linux .bash
+    bash_path = os.path.join(base, "BAT", f"{os.path.basename(app_name)}.bash")
+    with open(bash_path, "w") as f:
+        f.write(f"""#!/bin/bash
+export NODE=DEV
+open -a "{td_exec}" "{app_name}.toe"
+""")
+
+    for ext in ["StartupExt", "SettingsExt", "StateExt"]:
+        ext_path = os.path.join(base, "DAT", f"{ext}.py")
+        with open(ext_path, "w") as f:
+            f.write(f"class {ext}:\n    def __init__(self, ownerComp):\n        self.ownerComp = ownerComp\n")
+
+    click.echo(f"✅ Created TouchDesigner app scaffold at {base}")
+
+# ----------------------------
+# Extension stub
+# ----------------------------
+@click.command()
+@click.argument("ext_name")
+def create_ext(ext_name):
+    """Create a new extension stub"""
+    path = os.path.join("DAT", f"{ext_name}.py")
+    if not os.path.exists("DAT"):
+        click.echo("❌ No DAT directory found. Run start-app first.")
+        return
+
+    with open(path, "w") as f:
+        f.write(f"""class {ext_name}:
+    \"\"\"{ext_name} description\"\"\"
+    def __init__(self, ownerComp):
+        self.ownerComp = ownerComp
+""")
+    click.echo(f"✅ Created extension stub: {path}")
+
+# ----------------------------
+# Environment management
+# ----------------------------
+@click.command()
+@click.argument("env_name")
+def init_env(env_name):
+    """Initialize a Python virtual environment using uv (fallback to pip)"""
+    if check_tool("uv"):
+        click.echo(f"📦 Creating uv environment: {env_name}")
+        subprocess.run(["uv", "venv", env_name], check=True)
+        click.echo("✅ uv environment created")
+    elif check_tool("python"):
+        click.echo("⚠️ uv not found, falling back to Python venv + pip")
+        subprocess.run(["python", "-m", "venv", env_name], check=True)
+        subprocess.run([f"{env_name}/Scripts/pip", "install", "--upgrade", "pip"], check=True)
+        click.echo("✅ Python venv created and pip upgraded")
+    else:
+        click.echo("❌ Neither uv nor Python found. Please install one of them.")
+
+@click.command()
+@click.argument("env_name")
+def init_conda(env_name):
+    """Initialize a Conda environment"""
+    if not check_tool("conda"):
+        click.echo("❌ Conda is not installed. Please install Conda first.")
+        return
+    click.echo(f"📦 Creating Conda environment: {env_name}")
+    subprocess.run(["conda", "create", "-y", "-n", env_name, "python=3.12"], check=True)
+    click.echo("✅ Conda environment created")
+
+@click.command()
+def sync_env():
+    """Export requirements for reproducibility"""
+    click.echo("📤 Exporting requirements.txt")
+    subprocess.run(["uv", "pip", "freeze", ">", "requirements.txt"], shell=True)
+    click.echo("✅ requirements.txt exported")
+
+@click.command()
+@click.argument("env_file")
+def import_env(env_file):
+    """Import environment from requirements.txt or environment.yml"""
+    if env_file.endswith(".yml"):
+        click.echo(f"📥 Importing Conda environment from {env_file}")
+        subprocess.run(["conda", "env", "create", "-f", env_file], check=True)
+    else:
+        click.echo(f"📥 Importing uv environment from {env_file}")
+        subprocess.run(["uv", "pip", "install", "-r", env_file], check=True)
+    click.echo("✅ Environment imported")
+
+@click.command()
+def help():
+    """Show comprehensive help for tdfw"""
+    click.echo("""
+TouchDesigner Framework CLI (tdfw)
+
+Available commands:
+  
+  doctor                  Check system readiness for tdfw
+  start-app <name>        Scaffold a new TouchDesigner app
+    --td-path             Override TouchDesigner executable path
+
+  create-ext <name>       Create a new extension stub
+
+  init-env <name>         Create a uv-managed Python environment - falls back to Python venv if uv is not available
+  init-conda <name>       Create a Conda environment
+  sync-env                Export requirements.txt from current env
+  import-env <file>       Import env from requirements.txt or environment.yml
+""")
+
+@click.command()
+@click.option("--td-path", default=None,
+              help="Override path to TouchDesigner executable")
+def doctor(td_path):
+    """Check system readiness for tdfw"""
+    click.echo("🔎 Running tdfw system check...\n")
+
+    # uv
+    if check_tool("uv"):
+        click.echo("✅ uv found")
+    else:
+        click.echo("⚠️ uv not found (tdfw will fall back to pip)")
+
+    # pip
+    if check_tool("pip"):
+        click.echo("✅ pip found")
+    else:
+        click.echo("❌ pip not found — install Python with pip")
+
+    # conda
+    if check_tool("conda"):
+        click.echo("✅ conda found")
+    else:
+        click.echo("⚠️ conda not found (optional, only needed if you want Conda envs)")
+
+    # TouchDesigner executable
+    default_td_path = "C:\\Program Files\\Derivative\\TouchDesigner\\bin\\TouchDesigner.exe"
+    td_exec = td_path if td_path else default_td_path
+    if os.path.exists(td_exec):
+        click.echo(f"✅ TouchDesigner executable found at {td_exec}")
+    else:
+        click.echo(f"⚠️ TouchDesigner executable not found at {td_exec}. Use --td-path to override.")
+
+    click.echo("\n🩺 System check complete.")
+
+# ----------------------------
+# Register commands
+# ----------------------------
+cli.add_command(help)
+cli.add_command(doctor)
+cli.add_command(start_app)
+cli.add_command(create_ext)
+cli.add_command(init_env)
+cli.add_command(init_conda)
+cli.add_command(sync_env)
+cli.add_command(import_env)

tdfw-0.1.1/tdfw.egg-info/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.4
+Name: tdfw
+Version: 0.1.1
+Summary: TouchDesigner Framework CLI scaffold tool for opinionated State Driven Command and Control/Code Driven project architecture
+Author-email: Michael Kramer <michael.kramer.guitar@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/MichaelKramerGuitar/tdfw
+Project-URL: Repository, https://github.com/MichaelKramerGuitar/tdfw
+Project-URL: Issues, https://github.com/MichaelKramerGuitar/tdfw/issues
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Dynamic: license-file
+
+![Coverage](https://codecov.io/gh/MichaelKramerGuitar/tdfw/branch/main/graph/badge.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
+
+
+# tdfw
+TouchDesigner Framework CLI scaffold tool with an opinionated slant towards State Driven/Code Driven project architecture.
+
+## About
+
+Hi, I'm Michael. I play guitar and write code. I was introduced to TouchDesigner by my friend Andrew Zolty, who's also known as `BREAKFAST`. He's an incredible kinetic artist. 
+
+Getting started with TouchDesigner as a GUI never really happened for me. I started a few YouTube courses on it but didn't have the time to follow through and learn how to use the interface. 
+
+But the concept of a network of nodes and subnodes made sense to my programmer/software engineer brain. I thought "there must be a purely code driven way to architect these TouchDesinger apps". So I looked on YouTube and found [this](https://www.youtube.com/watch?v=nQT7EhYCVg0) video (read more about that in [BACKGROUND.md](./BACKGROUND.md)). I was thrilled and what has resulted is essentially this tool which abstracts out all the boilerplate he gives. 
+
+# How To Use
+
+```bash
+# Install 
+uv pip install tdfw
+
+# Confirm installation and check options
+tdfw help
+
+# Start a TouchDesigner App
+tdfw start-app <MyFirstApp>
+
+# Create a Python Extension stub (from your TouchDesigner Project Root i.e. the dir with the <MyFirstApp>.toe file)
+tdfw create-ext <MyFirstExt>
+```

tdfw-0.1.1/tdfw.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+tdfw/__init__.py
+tdfw/cli.py
+tdfw.egg-info/PKG-INFO
+tdfw.egg-info/SOURCES.txt
+tdfw.egg-info/dependency_links.txt
+tdfw.egg-info/entry_points.txt
+tdfw.egg-info/requires.txt
+tdfw.egg-info/top_level.txt
+tests/test_cli.py

tdfw-0.1.1/tdfw.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

tdfw-0.1.1/tdfw.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+tdfw = tdfw.cli:cli

tdfw-0.1.1/tdfw.egg-info/requires.txt

@@ -0,0 +1 @@
+click

tdfw-0.1.1/tdfw.egg-info/top_level.txt

@@ -0,0 +1 @@
+tdfw

tdfw-0.1.1/tests/test_cli.py

@@ -0,0 +1,116 @@
+# tests/test_cli.py
+import os
+import shutil
+import pytest
+from click.testing import CliRunner
+from tdfw import cli
+
+@pytest.fixture
+def runner():
+    return CliRunner()
+
+@pytest.fixture
+def temp_app(tmp_path):
+    """Create a temporary app directory for testing."""
+    app_dir = tmp_path / "MyTestApp"
+    yield app_dir
+    if app_dir.exists():
+        shutil.rmtree(app_dir)
+
+def test_start_app_creates_structure(runner, temp_app):
+    result = runner.invoke(cli.start_app, [str(temp_app)])
+    assert result.exit_code == 0
+    assert (temp_app / "BAT").exists()
+    assert (temp_app / "DAT").exists()
+    assert (temp_app / "LOG").exists()
+    assert (temp_app / "README.md").exists()
+    assert (temp_app / ".gitignore").exists()
+    assert (temp_app / "BAT" / "MyTestApp.bat").exists()
+    assert (temp_app / "BAT" / "MyTestApp.bash").exists()
+    for ext in ["StartupExt.py", "SettingsExt.py", "StateExt.py"]:
+        assert (temp_app / "DAT" / ext).exists()
+
+def test_start_app_echo_message(runner, temp_app):
+    result = runner.invoke(cli.start_app, [str(temp_app)])
+    assert "✅ Created TouchDesigner app scaffold" in result.output
+
+def test_create_ext_adds_file(runner, temp_app):
+    runner.invoke(cli.start_app, [str(temp_app)])
+    cwd = os.getcwd()
+    os.chdir(temp_app)
+    result = runner.invoke(cli.create_ext, ["CameraExt"])
+    os.chdir(cwd)
+    assert result.exit_code == 0
+    ext_file = temp_app / "DAT" / "CameraExt.py"
+    assert ext_file.exists()
+    content = ext_file.read_text()
+    assert "class CameraExt" in content
+
+def test_create_ext_without_dat(runner, tmp_path):
+    os.chdir(tmp_path)
+    result = runner.invoke(cli.create_ext, ["FooExt"])
+    assert result.exit_code == 0
+    assert "❌ No DAT directory found" in result.output
+
+# ----------------------------
+# New command tests
+# ----------------------------
+
+def test_help_command(runner):
+    result = runner.invoke(cli.help)
+    assert result.exit_code == 0
+    assert "TouchDesigner Framework CLI" in result.output
+    assert "start-app" in result.output
+    assert "init-env" in result.output
+
+def test_doctor_command_defaults(runner, tmp_path):
+    # Run doctor with no override
+    result = runner.invoke(cli.doctor)
+    assert result.exit_code == 0
+    assert "System check complete" in result.output
+
+def test_init_env_fallback(runner, tmp_path, monkeypatch):
+    # Patch inside cli module
+    monkeypatch.setattr(cli, "check_tool", lambda tool: tool == "python")
+    env_dir = tmp_path / "venvtest"
+    result = runner.invoke(cli.init_env, [str(env_dir)])
+    assert "falling back to Python venv" in result.output
+
+def test_init_conda_missing(runner, monkeypatch):
+    # Patch inside cli module
+    monkeypatch.setattr(cli, "check_tool", lambda tool: False)
+    result = runner.invoke(cli.init_conda, ["myenv"])
+    assert "❌ Conda is not installed" in result.output
+
+def test_init_env_no_tools(runner, monkeypatch):
+    # Simulate neither uv nor python available
+    monkeypatch.setattr(cli, "check_tool", lambda tool: False)
+    result = runner.invoke(cli.init_env, ["envX"])
+    assert "❌ Neither uv nor Python found" in result.output
+
+def test_sync_env_runs(runner, monkeypatch):
+    # Patch subprocess.run to avoid actually running uv
+    monkeypatch.setattr(cli.subprocess, "run", lambda *a, **k: None)
+    result = runner.invoke(cli.sync_env)
+    assert result.exit_code == 0
+    assert "requirements.txt exported" in result.output
+
+def test_import_env_yml(runner, tmp_path, monkeypatch):
+    env_file = tmp_path / "env.yml"
+    env_file.write_text("name: testenv")
+    monkeypatch.setattr(cli.subprocess, "run", lambda *a, **k: None)
+    result = runner.invoke(cli.import_env, [str(env_file)])
+    assert "Importing Conda environment" in result.output
+
+def test_import_env_txt(runner, tmp_path, monkeypatch):
+    env_file = tmp_path / "requirements.txt"
+    env_file.write_text("click")
+    monkeypatch.setattr(cli.subprocess, "run", lambda *a, **k: None)
+    result = runner.invoke(cli.import_env, [str(env_file)])
+    assert "Importing uv environment" in result.output
+
+def test_doctor_missing_td_path(runner, tmp_path):
+    # Point doctor to a non-existent path
+    fake_path = tmp_path / "TouchDesigner.exe"
+    result = runner.invoke(cli.doctor, ["--td-path", str(fake_path)])
+    assert "TouchDesigner executable not found" in result.output