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==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

blender-stubs-3.0.0.24.dev1305892636.tar.gz (449.3 kB view details)

Uploaded Source

File details

Details for the file blender-stubs-3.0.0.24.dev1305892636.tar.gz.

File metadata

  • Download URL: blender-stubs-3.0.0.24.dev1305892636.tar.gz
  • Upload date:
  • Size: 449.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for blender-stubs-3.0.0.24.dev1305892636.tar.gz
Algorithm Hash digest
SHA256 5577cad964e30e540a1a73a80085c2ea8f184e22b3e9718246186d324c810b0c
MD5 857d6e9a6eef1d808a52e9fd935bc9dc
BLAKE2b-256 2a9a591b73971e9dd14efeec54e06f510436bdd43a47f184279df28310c64441

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