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
Showing only changes of commit 1ebfa51fe3 - Show all commits

View File

@ -1,5 +1,5 @@
# blender-crawl # 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 purge orphan data of blend files via the console.
## Table of Contents ## Table of Contents
- [Prerequisite](#prerequisite) - [Prerequisite](#prerequisite)
@ -11,9 +11,9 @@ In order to use this tool you need:
- python3 - python3
## Run without Installation ## Run without Installation
1. Clone repository 1. Clone repository the
2. run `cd blender-crawl` to enter directory 2. run `cd blender_crawl` to enter directory
3. Run program with `python blender-crawl /directory/` 3. Run program with `python blender_crawl /directory/`
## Installation ## Installation
Download or clone this repository. Download or clone this repository.
@ -21,16 +21,16 @@ This repository is a command line tool that can be installed with the python pac
This script does the following (follow this if you want to do this manually or on another platform): This script does the following (follow this if you want to do this manually or on another platform):
1. Clone repository 1. Clone repository
2. Run `cd blender-crawl` to enter directory 2. Run `cd blender_crawl` to enter directory
3. Install with `python setup.py install` 3. Install with `python setup.py install`
4. Run with `sudo python -m blender-crawl /directory/` 4. Run with `sudo python -m blender_crawl /directory/`
5. Get help with `sudo python3 -m blender-crawl -h` 5. Get help with `sudo python3 -m blender_crawl -h`
## How to get started ## How to get started
Run directly out of repo folder or follow above installation instructions. Run directly out of repo folder or follow above installation instructions.
Give `blender-crawl` a path to a .blend file or a folder as first argument. Give ``blender_crawl`` a path to a .blend file or a folder as first argument.
The detected blend files will be opened in the background, their orphan data will be The detected blend files will be opened in the background, their orphan data will be
purged recursively, the file gets saved and closed again. This will happen twice for each .blend file. purged recursively, the file gets saved and closed again. This will happen twice for each .blend file.