DX Python Tools for Isadora

Overview

DX Python Tools is a collection of user actors for Isadora that enhances Pythoner workflow and virtual environment management. These tools are designed to complement Isadora’s built-in Python capabilities while providing advanced features for developers who integrate external code editors like PyCharm into their workflow. These actors work with the default Python environment provided with Pythoner, and therefore are extremely easy to get started with.

User Actors

1. DX – PY – Virtual Environment Manager

This actor provides essential tools for managing Python virtual environments within your Isadora projects:

Features:

1. Create VENV from requirements.txt

• Creates a new virtual environment using a requirements.txt file
• Validates environment locations and package dependencies
• Provides clear status messages during creation process
• Supports both Windows and macOS

2. Create requirements.txt from Active VENV

• Generates a requirements.txt file based on the currently active virtual environment
• Automatically excludes system packages like pip and virtualenv
• Places the file in your project directory for easy access
• Ideal for sharing project dependencies with collaborators

3. Update ActiveVirtualEnvironmentPath.txt

• Updates the system path to your active Python virtual environment
• Most useful when creating a catch all VENV for general development

4. Validate requirements.txt

• Verifies that all packages in your requirements.txt file are available on PyPI
• Checks if compatible wheels exist for your platform
• Warns about missing or incompatible packages
• Requires internet access (uses PyPI web API)

2. DX – PY – Helpers

This actor provides utility functions to enhance your Python development workflow:

Features:

1. System Path & Configuration

• Provides quick access to important system paths
• Shows configuration information for your Python environment
• Displays status of virtual environment settings

2. Folder & File Management

• Opens important folder locations with a single click
• Creates required directories for your project
• Browse and select folders using native OS dialogs

3. VENV Management Tools

• Install or uninstall modules from the active virtual environment
• Quick creation of local virtual environments for your project

4. Cache Management

• Clear Python module cache (critical when working with link files and sub-files)
• Ensures changes to Python files are immediately recognized

Beta Release Notes

• These tools are in BETA status, feedback is encouraged. Please post to the user forum.
• Both actors work on Windows and macOS platforms
• Some functions may require administrative privileges to modify system files
• Designed to complement the existing Isadora Python workflow

System Requirements

• Isadora 4 with Pythoner plugin
• Internet connection for package validation features

Getting Started

1. Place either or both User Actors in your Isadora project.
   Note: ‘DX – PY – Helpers’ is useful in all Isadora projects using Pythoner
2. The User Actors have many help comments included. Ensure the Information Panel is open in Isadora, so you can read the help when you rollover: the actors, the inputs, and the outputs.
3. Open the Monitor Window for additional details.

Recommended Workflow

The DX Python Tools are especially powerful when used with external code editors like PyCharm, VS Code and others.
The recommended workflow is:

1. Create a folder on your system for your Isadora project.
2. Create a new Isadora File and save it into your new folder.
3. Use this folder as the home of your project, all related files now go into this folder. (In Pycharm you will open this folder as a project)
4. Create your VENV (virtual environment)
   – If you have a requirements.txt file, set up your virtual environment using the VENV Manager (action #1)
   – If not use ‘Create VENV in virtual_env’ to create a local virtual environment for your project
5. Use the provided tools to add new modules as needed. Once you have the environment setup as you need it, use the VENV Manager (action #2) to record its configuration
6. Use the tools provided to create a ‘python_modules’ folder, and save all your python files there.
7. In Pythoner use the ‘ext file’ input to link to your external files. eg: python_modules/python-file.py
8. Edit your Python code in your preferred external editor.
9. Use “if __name__ == ‘__main__’:” in your python files to allow you to run/debug your code in your external editor.
10. Use the helper tools to manage paths and configurations
11. Run your code directly in Isadora to see the results
12. Clear the Python module cache when changes aren’t being detected (this will happen your external files are loading additional files that you are editing. Isadora can only sense changes to files connected directly via the ‘ext file’ input of the Pythoner actor.

This release provides a foundation for more streamlined Python development within Isadora projects, with a focus on professional workflows that incorporate external development tools.

Change Log

version 1.0.3

• combined VENV creation scripts
• fixed issue with python paths on clean system
• fixed issue with pythonXXX.zip and DLLs on Windows
• fixed symlink issue on Mac
• numerous other housekeeping tasks