API stubs for Blender and UPBGE generated with bpystubgen.
Project description
Blender / UPBGE API Stubs
This module provides type information for Blender and UPBGE's Python API, following the PEP-561 standard.
It was generated using BPY Stub Generator which is also available on PyPI as a separate module.
Screenshots
Auto-completion at work in PyCharm:
Pop-up documentation support in VSCode:
Installation
There are two variants of the API stubs, one for Blender and the other for UPBGE. For Blender,
you can install blender-stubs
module with appropriate version qualifier as follows:
$ pip install blender-stubs==2.93.*
This will install the latest module for Blender 2.93, and for now stubs are provided for Blender
2.80 and onwards. You can also specify the next unreleased version as 3.0.*
to get the latest
snapshot of the module.
As for UPBGE, stubs are available for the upcoming 0.3 release, which you can install as follows:
$ pip install upbge-stubs==0.3.*
You can also install it using Pipenv
. Note that it is required to set allow_preleases
option
in case the target application has no stable release (i.e. UPBGE 0.3 branch). You can use the
following content as a template for your Pipfile
:
[[source]]
name = "pypi"
url = "https://pypi.org/simple"
verify_ssl = true
[packages]
"upbge-stubs" = "==0.3.*"
[requires]
python_version = "3.9"
[pipenv]
allow_prereleases = true
Also, it would be more correct to use [dev-packages]
instead of [packages]
, in which
case you can install or update the stubs using the -d
flag like pipenv update -d
.
License
This project is provided under the terms of GNU General Public License v3 (GPL3).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for blender-stubs-3.0.0.25.dev1352657684.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34a8c4aaa4396480596c4fec0bf615438f2edab90a2092d5cafb7bdb43e683e3 |
|
MD5 | ce113555f4a20837dc95ba52fffd20cb |
|
BLAKE2b-256 | 088da73dfb9ee64d004c6c19913e7b22232ce6abc83fded997ce423c5c3206dc |