Skip to main content

A CLI and Python module for executing Blender scripts and managing Blender's Python environment. Built to support SceneProg projects.

Project description

🚀 SceneProgExec: Blender Python Script & Package Manager

SceneProgExec is a command-line tool and Python module that enables seamless execution of Blender scripts and package management within Blender's isolated Python environment.

🔥 Features

Execute Python scripts inside Blender
Install Python packages in Blender's Python environment
Perform a full reset (remove all third-party packages)
Automatically cleans up temporary files after execution
Works both as a CLI tool and a Python module
Debugging with LLM

📥 Installation

1️⃣ Install from PyPI

pip install sceneprogexec

OR Clone the Repository

git clone https://github.com/KunalMGupta/SceneProgExec.git
cd SceneProgExec
pip install .

2️⃣ Set Environment Variables

Before using SceneProgExec, set the required environment variables:

export BLENDER_PATH=/Applications/Blender.app/Contents/MacOS/Blender
export BLENDER_PYTHON=/Applications/Blender.app/Contents/Resources/4.3/python/bin/python3.11

To make this permanent, add the lines to your ~/.bashrc or ~/.zshrc:

echo 'export BLENDER_PATH=/Applications/Blender.app/Contents/MacOS/Blender' >> ~/.zshrc
echo 'export BLENDER_PYTHON=/Applications/Blender.app/Contents/Resources/4.3/python/bin/python3.11' >> ~/.zshrc
source ~/.zshrc

3️⃣ Run CLI Commands

Once installed, you can use sceneprogexec globally.


🛠️ Usage

🔹 Run a Python Script Inside Blender

sceneprogexec run my_script.py --target my_scene.blend

✅ Runs my_script.py inside Blender.

🔹 Run a Python Script Inside Blender with Debugging

sceneprogexec run my_script.py --target my_scene.blend --debug

✅ Runs my_script.py inside Blender with debugging.


🔹 Install Packages Inside Blender

sceneprogexec install numpy pandas

✅ Installs numpy and pandas inside Blender’s Python.


🔹 Install Packages With a Hard Reset

sceneprogexec install numpy pandas --reset

Removes all third-party packages before installing new ones.


🔹 Reset Blender's Python (Remove All Third-Party Packages)

sceneprogexec reset

🗑️ Deletes all third-party Python packages in Blender.


🏗️ Using as a Python Module

SceneProgExec can also be imported and used in Python scripts:

from sceneprogexec import SceneProgExec

executor = SceneProgExec()
executor.install_packages(["numpy"])
executor.run_script("my_script.py")
executor._delete_all_third_party_packages()  # Hard reset

script = """
import bpy
print("Hello, World!")
"""
executor(script, target="test.blend")

🔹 Run a Python Script Inside Blender with Debugging

executor = SceneProgExec()
executor.run_script("my_script.py", debug=True)

🚀 Automatic Cleanup

  • Temporary directory (blender_tmp) is deleted after execution.
  • No leftover logs or scripts clutter your system.

🛠️ Troubleshooting

Blender not found?
Ensure BLENDER_PATH and BLENDER_PYTHON are correctly set. Run:

echo $BLENDER_PATH
echo $BLENDER_PYTHON

Permission denied?
Try:

chmod +x /usr/local/bin/sceneprogexec

Blender script fails to execute?
Check the log:

cat blender_tmp/blender_log.txt

📝 License

This project is licensed under the MIT License.


👨‍💻 Author

Developed by Kunal Gupta
GitHub: KunalMGupta


Support the Project

If you find this tool useful, give it a ⭐ on GitHub!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sceneprogexec-0.1.2.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sceneprogexec-0.1.2-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file sceneprogexec-0.1.2.tar.gz.

File metadata

  • Download URL: sceneprogexec-0.1.2.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for sceneprogexec-0.1.2.tar.gz
Algorithm Hash digest
SHA256 1858a8573c370883ec42219028436aa152bbf07a1a4c61b180e9272e361ada23
MD5 b68df1cccece7c407b13fa05595450ef
BLAKE2b-256 d1e34bf0a8cf84c84aa83a9a41488c55abb139ef142faf9de6f169449bfed0bb

See more details on using hashes here.

File details

Details for the file sceneprogexec-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: sceneprogexec-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for sceneprogexec-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 50ae7383acbc794f234d46bd71c85cef6f7353b74d25505fc027e9c6bc670522
MD5 9c1cdab240b124e41bb7bb2d691c7ebe
BLAKE2b-256 c663b361b0b41f7c708c3a7ba7bb57b597eb5e461e4d637fcf9c7ad5db05369d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page