studio/blender-studio-tools
13
32
Fork 19
Code Issues 22 Pull Requests 4 Projects Releases 1 Activity

Convert Blender-Purge to a more generic Blender-Crawl Tool #42

Merged
Nick Alberelli merged 34 commits from feature/blender-crawl into main 2023-05-17 15:38:47 +02:00
Conversation 0 Commits 34 Files Changed 19 +10 -32
1 changed files with 10 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 739b213144 - Show all commits

42
scripts/blender-crawl/README.md
View File

@ -1,6 +1,5 @@
# blender_crawl
blender_crawl is a command line tools to purge orphan data of blend files via the console.
`blender_crawl` is a command line tools to crawl directories for .blend files and execute a provied script.
## Table of Contents
- [Prerequisite](#prerequisite)
- [Installation](#installation)
@ -42,35 +41,14 @@ Run directly out of repo folder or follow above installation instructions. Give
## Usage Examples
### Basic Operation
Prints the names of .blends in Current Directory
> `python -m blender_crawl ./`
### Recursive
Print the names of .blends Recursively
> `python -m blender_crawl /my-folder/ --recursive`
### Find
Print only the names of .blends matching a provided string
> `python -m blender_crawl /my-folder/ --find string`
### Purge
Run default 'Purge' script on .blends in Current Directory
> `python -m blender_crawl /my-folder/ --purge`
### Script
Run custom script on all .blends in Current Directory
> `python -m blender_crawl /my-folder/ --script /my-directory/my-script.py`
### Ask
Ask/Prompt before script execution
> `python -m blender_crawl /my-folder/ --script /my-directory/my-script.py --ask`
### Exec
Run with a custom blender executable
> `python -m blender_crawl /my-folder/ --exec /path-to-blender-executable/blender`
| Action | Command |
| ----------- | ----------- |
|Prints the names of .blends in Current Directory | `python -m blender_crawl ./` |
|Print the names of .blends Recursively | `python -m blender_crawl /my-folder/ --recursive` |
|Print only the names of .blends matching a provided string |`python -m blender_crawl /my-folder/ --find string`|
|Run default 'Purge' script on .blends in Current Directory |`python -m blender_crawl /my-folder/ --purge`|
|Run custom script on all .blends in Current Directory |`python -m blender_crawl /my-folder/ --script /my-directory/my-script.py`|
|Ask/Prompt before script execution|`python -m blender_crawl /my-folder/ --script /my-directory/my-script.py --ask`|
|Run with a custom blender executable|`python -m blender_crawl /my-folder/ --exec /path-to-blender-executable/blender`|