xury/bpy-wizard
Watch
1
0
Fork
You've already forked bpy-wizard
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Cross-platform TUI tool to help set up a Python environment for Blender add-ons and extensions.
38 commits 1 branch 0 tags 764 KiB
  • Python 98.5%
  • Shell 0.8%
  • Batchfile 0.7%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Xury Greer cd7c5148d8 Minor fixups
2026-07-19 10:16:44 -07:00
.schemas Install TOML .json schemas locally 2026-07-18 23:21:07 -07:00
.vscode better launch 2026-07-19 10:16:44 -07:00
scripts Create bpy_wizard entry point 2026-07-19 10:03:41 -07:00
src/bpy_wizard Minor fixups 2026-07-19 10:16:44 -07:00
tests/fixtures split into multi-file module 2026-07-19 10:15:11 -07:00
.cspell.json WIP interactive 2026-07-19 10:16:44 -07:00
.gitattributes Track .blend files in Git LFS 2026-07-18 23:21:07 -07:00
.gitignore Add root .gitattributes and .gitignore 2026-07-10 23:37:21 -07:00
.python-version Initialize project with uv init --package 2026-07-15 09:09:52 -07:00
LICENSE Add MIT license 2026-07-18 23:21:07 -07:00
pyproject.toml Add rules to avoid reporting known bpy type hint issues 2026-07-18 23:21:07 -07:00
README.md Update README.md 2026-07-19 10:03:41 -07:00
ruff.toml Add rules for Python formatting with ruff 2026-07-18 12:41:13 -07:00
tombi.toml Install TOML .json schemas locally 2026-07-18 23:21:07 -07:00
uv.lock Install fake-bpy-module with uv add --dev 2026-07-18 23:21:07 -07:00

README.md 

         ,--.                                                          
         `.  `.        _                   _    _ _                  _ 
  ,--------`   `.     | |                 | |  | (_)                | |
  `---,   ,-``-. `.   | |__  _ __  _   _  | |  | |_ ______ _ _ __ __| |
    ,`   / ,``. \  \  | '_ \| '_ \| | | | | |/\| | |_  / _` | '__/ _` |
  ,' .   : '..' !  |  | |_) | |_) | |_| | \  /\  / |/ / (_| | | | (_| |
,` ,` \   `.__,'   ;  |_.__/| .__/ \__, |  \/  \/|_/___\__,_|_|  \__,_|
 ``    `.        ,'         | |     __/ |                              
         `------`           |_|    |___/

bpy Wizard

Cross-platform TUI tool to help set up a Blender Python environment for developing add-ons and extensions.

Note: This is just a convenience tool, it provides a structured workflow to setting up your dev environment.
However, the real functionality is driven by git, uv, and standard shell commands.
It is not necessary to keep bpy-wizard installed once you've used it to set up your environment, it's just a helper.
You should keep git and uv installed for developing your add-ons.

Prerequisites:

Make sure you have git and uv installed.
git will be used clone the repository, uv will be used to set up the Python environment and install the tool.
After these are installed, you can use them to install bpy-wizard.

How to install

Windows

  • Open a terminal (You can use the integrated terminal in your code editor, or a cmd / powershell window).
    • Tip: type cmd into the address bar of Windows File Explorer to launch a command prompt in that directory.
  • In the terminal navigate to the directory you want to install bpy-wizard into
    e.g. use the change directory command:
cd %USERPROFILE%\Documents
  • copy-paste and run the following command to install bpy-wizard:
git clone https://forgejo.xury.com/xury/bpy-wizard.git; \
uv tool install ./bpy-wizard

Linux / MacOS

  • Open a terminal (You can use the integrated terminal in your code editor, or a stand-alone console window).
  • In the terminal navigate to the directory you want to install bpy-wizard into
    e.g. use the change directory command:
cd ~/Projects
  • copy-paste and run the following command to install bpy-wizard:
git clone https://forgejo.xury.com/xury/bpy-wizard.git; \
uv tool install ./bpy-wizard

How to use

  • uv installs the package as an executable tool, to run it just type the command:
bpy-wizard
  • The terminal user interface (TUI) will walk you through the rest.