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

Side Effects

Using this package has side effects that the user should be aware of. Side effects will occurs after PyR3 is imported (PyR3.__init__ is run).

See Side Effects on Installation page for more in-depth description.

Because we often want those side effects to be guaranteed to happen, I encourage you to instead of simply importing bpy, use following

from PyR3.bpy import bpy

It will cause PyR3.__init__ to be always invoked before you request bpy.

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.

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.1.2.tar.gz (543.2 kB view hashes)

Uploaded Source

Built Distribution

PyR3-0.1.2-py3-none-any.whl (21.4 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