Skip to main content

A set of tools extending the capabilities of bpy (blender as a python module).

Project description

https://raw.githubusercontent.com/Argmaster/pyr3/main/docs/_static/logo_wide.png

Overview

The PyR3 package serves two purposes:
  • provides blender in form of python package (bpy)

  • contains useful shortcuts and abstractions over bpy API

This software is completely free to use: is released under MIT license.

Installation

PyR3 is available on Python Package Index and can be installed automatically with pip:

pip install PyR3

You can also install the in-development version from github with:

pip install https://github.com/Argmaster/pyr3/archive/main.zip

Complicated bpy requirement

Unlike previous releases, since 0.2.2 bpy is no longer automatically installed when importing PyR3, as this solution was not what’s expected by typical developer.

Now to install bpy automatically you have to invoke PyR3.install_bpy module .. code-block:: bash

python -m PyR3.install_bpy

Or you can use install_bpy_lib() function from this module. After installing bpy it has to be manually uninstalled. It may happen that in future releases some uninstall script will be created, but for now manual removal is the only way.

Documentation

Documentation is available on-line at https://pyr3.readthedocs.io/

You can also build documentation yourself using tox:

git clone hhttps://github.com/Argmaster/pyr3.git
cd PyR3
tox -e docs

Changelog

0.0.0 (2021-09-27)

  • First release on PyPI.

0.1.0 (2021-10-01)

  • Added Modifiers: Boolean, Array, Solidify and Bevel

  • Added fromPyData()

  • Improved documentation

  • Added example files

  • Added dark theme to docs

0.1.1 (2021-10-01)

  • Hotfix of missing dependencies in package

0.1.2 (2021-10-01)

  • Hotfix of export/import API

0.2.0 (2021-10-03)

  • Added materials shortcuts

  • Updated documentation

  • Bpy is no longer automatically installed

  • Bpy can be now installed via PyR3.install_bpy script

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

PyR3-0.2.2.tar.gz (545.7 kB view hashes)

Uploaded Source

Built Distribution

PyR3-0.2.2-py3-none-any.whl (23.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page