Metadata-Version: 2.1
Name: bpsrender
Version: 0.1.40.post2
Summary: Blender Power Sequencer Renderer
Home-page: https://github.com/gdquest/BPSRender
Author: Răzvan C. Rădulescu
Author-email: razcore.art@gmail.com
License: GPLv3
Keywords: blender render parallel multiprocess speedup utility productivty
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Utilities
Requires-Dist: tqdm

Blender Power Sequencer Render - BPSRender
==========================================

This is a `standalone python
package <https://pypi.org/project/bpsrender/>`__ as well as a module
which is used under the hood in the `Blender Power Sequencer
add-on <https://github.com/GDquest/Blender-power-sequencer>`__ to speed
up rendering `VSE
projects <https://docs.blender.org/manual/en/dev/editors/vse/index.html>`__
by spawning Blender processes in background in parallel.

|image0|

Install
-------

It can be installed as a standalone command line utility `via
PiPy <https://pypi.org/project/bpsrender/>`__:
``pip install [--user] bpsrender``. *Note* that you have to have
``$HOME/.local/bin`` included in your ``$PATH`` environment variable (on
unix) if you’re going to install the utility locally (using ``--user``
when executing ``pip``).

Usage
-----

After installing the script, get help by writing ``bpsrender -h``:

::

   usage: bpsrender [-h] [-o OUTPUT] [-w WORKERS] [-v] [--dry-run] [-s START]
                    [-e END] [-m] [-c] [-d] [-j]
                    blendfile

   Multi-process Blender VSE rendering - will attempt to create a folder called
   `render` inside of the folder containing `blendfile`. Insider `render` another
   folder called `parts` will be created for storing temporary files. These files
   will be joined together as the last step to produce the final render which
   will be stored inside `render` and it will have the same name as `blendfile`

   positional arguments:
     blendfile             Blender project file to render.

   optional arguments:
     -h, --help            show this help message and exit
     -o OUTPUT, --output OUTPUT
                           Output folder (will contain a `bpsrender` temp folder
                           forrendering parts).
     -w WORKERS, --workers WORKERS
                           Number of workers in the pool (for video rendering).
     -v, --verbose         Increase verbosity level (eg. -vvv).
     --dry-run             Run the script without actual rendering or creating
                           files and folders. For DEBUGGING purposes
     -s START, --start START
                           Start frame
     -e END, --end END     End frame
     -m, --mixdown-only    ONLY render the audio MIXDOWN
     -c, --concatenate-only
                           ONLY CONCATENATE the (already) available video chunks
     -d, --video-only      ONLY render the VIDEO (implies --concatenate-only).
     -j, --join-only       ONLY JOIN the mixdown with the video. This will
                           produce the final render

External Dependencies
---------------------

BPSRender requires

-  ``blender``
-  ``ffmpeg``

to be available in the ``$PATH`` environment variable in order to work.
In case BPSRender will catch a missing dependency it will throw a
message error similar to this:

::

   BPSRender couldn't find external dependencies:
   [v] blender: /home/razvan/.local/bin/blender
   [X] ffmpeg: NOT FOUND
   Check if you have them properly installed and available in the PATH environemnt variable.
   Exiting...

Known Issues
------------

-  [ ] CTRL-C interrupt leaves subprocesses running in the background
-  [ ] CTRL-C interrupt doesn’t clean the folders yet

.. |image0| image:: https://i.imgur.com/BndLccL.gif



