1 unstable release

0.1.0 Apr 27, 2024

#50 in Rendering

Download history 154/week @ 2024-04-22 26/week @ 2024-04-29 16/week @ 2024-05-13 9/week @ 2024-05-20

88 downloads per month

MIT/Apache

525KB
10K SLoC

blr

crates.io docs.rs Rust Docker deps.rs codecov.io

Rust interface for the Python API of Blender. The interface is facilitated via PyO3.

Instructions

Rust

Add blr as a Rust dependency to your Cargo.toml manifest.

[dependencies]
blr = { version = "0.1" }

Docker

To install Docker on your system, you can run .docker/host/install_docker.bash to configure Docker with NVIDIA GPU support.

.docker/host/install_docker.bash

Build Image

To build a new Docker image from Dockerfile, you can run .docker/build.bash as shown below.

.docker/build.bash ${TAG:-latest} ${BUILD_ARGS}

Run Container

To run the Docker container, you can use .docker/run.bash as shown below.

.docker/run.bash ${TAG:-latest} ${CMD}

Run Dev Container

To run the Docker container in a development mode (source code mounted as a volume), you can use .docker/dev.bash as shown below.

.docker/dev.bash ${TAG:-latest} ${CMD}

As an alternative, users familiar with Dev Containers can modify the included .devcontainer/devcontainer.json to their needs. For convenience, .devcontainer/open.bash script is available to open this repository as a Dev Container in VS Code.

.devcontainer/open.bash

Join Container

To join a running Docker container from another terminal, you can use .docker/join.bash as shown below.

.docker/join.bash ${CMD:-bash}

Status

This project is in early development, and as such, many features are missing and the API is not yet stable. The initial implementation targets Blender 3.6, but it will be updated to 4.x in the future.

License

This project is dual-licensed to be compatible with the Rust project, under either the MIT or Apache 2.0 licenses.

Contributing

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~9–19MB
~286K SLoC