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

Package License Documentation Status Workflow Status Workflow Status Code coverage stats GitHub release (latest by date) GitHub commit activity GitHub pull requests GitHub closed pull requests GitHub issues GitHub code size in bytes PyPI Package latest release PyPI Wheel Supported versions Supported implementations
The PyR3 package serves two purposes:
  • provides blender in form of python package (bpy)

  • contains useful shortcuts and abstractions over bpy API

This package is released under MIT license. Be aware that dependencies might be using different licenses.

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:

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

0.2.3 (2021-10-03)
  • Updated documentation

0.3.0 (2021-10-21)
  • Introduced new development pipeline

  • Extendent usage documentation

  • .blend1 files no longer can be imported/exported with shortcuts.io functions

  • Added LibraryManager class for managing 3D component libraries

  • Added LibraryObject class responsible for managing libraries

  • Added LibraryInfoV1_0_0 and ModelInfoV1_0_0 classes for __lib__.yaml version 1.0.0 files validation

  • Added way to extend set tags of a model from __lib__.yaml - via __user__.yaml

  • Added documentation for newest features

  • Added MeshProject class and project configuration convention

  • Added PlaceFile class which can parse place file and convert it into MeshProject file

  • Added PyR3.construct CLI for operating on MeshProject files

  • Added PyR3.meshlib CLI for operating on mesh libraries

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.3.0.tar.gz (2.1 MB view hashes)

Uploaded source

Built Distribution

PyR3-0.3.0-py3-none-any.whl (46.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page