Skip to main content

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: Screenshot in PyCharm

Pop-up documentation support in VSCode: Screenshot 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==3.0.26

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.1.* to get the latest snapshot of the module:

$ pip install blender-stubs==3.1.*

A stub module for UPBGE 0.3, as well as pre-release versions for the master branch are also available on PyPI repository. For the stable version, you can install it as follows:

$ pip install upbge-stubs==0.3.0.26

And for the latest snapshot,

$ pip install upbge-stubs==0.3.1.*

You can also install the module using Pipenv. Note that it is required to set allow_preleases option in case you want to install a snapshot release (e.g. UPBGE 0.3.1.*).

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.1.*"

[requires]
python_version = "3.10"

[pipenv]
allow_prereleases = true

You may want to use [dev-packages] instead of [packages] as it's more appropriate to do so, 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

upbge-stubs-0.3.1.26.dev1700379225.tar.gz (536.9 kB view details)

Uploaded Source

File details

Details for the file upbge-stubs-0.3.1.26.dev1700379225.tar.gz.

File metadata

  • Download URL: upbge-stubs-0.3.1.26.dev1700379225.tar.gz
  • Upload date:
  • Size: 536.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for upbge-stubs-0.3.1.26.dev1700379225.tar.gz
Algorithm Hash digest
SHA256 d37e0a2df08de47b8f1bded0490c8cbb1e34a26cdab88766e104d69252a48331
MD5 4a63043153b09a443e953d513871826c
BLAKE2b-256 a0cefedb7b3851be46b6ac2ac5c69af69098382253d3eecdcc7cfcf56b130d9e

See more details on using hashes here.

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