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)
Works both as a CLI tool and a Python module

📥 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/5.0/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/5.0/python/bin/python3.11' >> ~/.zshrc
source ~/.zshrc

Important! In case running this inside a linux container install the following dependencies:

apt update
apt install -y libx11-6 libxi6 libxxf86vm1 libxrender1 libgl1 libxfixes3 libxkbcommon-x11-0

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.


🔹 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")

🚀 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.2.4.tar.gz (6.2 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.2.4-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sceneprogexec-0.2.4.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for sceneprogexec-0.2.4.tar.gz
Algorithm Hash digest
SHA256 482a9ef66c15fe19ac0d9f5e3473095017169115b481cf75299bff91f39e40d7
MD5 5c82c0cdd07e10f10e97752f86d4b446
BLAKE2b-256 14d563b4eec4f92776ce796b594dd4cd85f9e69c9817ddc58b81ecf340557d7d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sceneprogexec-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for sceneprogexec-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e4ee21596efa5fae5a53ed366c416a03397d1e7509463afa253162b10dc0b2c4
MD5 73d5afba45f4bdf5d02bc9a345851327
BLAKE2b-256 1b1d4a49dffd0c577cb4e700643edeba3926d9ff84f57e1f86301c616a2c8514

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