# fake-bpy-module

**Repository Path**: billscofield/fake-bpy-module

## Basic Information

- **Project Name**: fake-bpy-module
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-02
- **Last Updated**: 2022-03-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Fake Blender Python API module collection: fake-bpy-module

fake-bpy-module is the collections of the fake Blender Python API modules for the code completion in commonly used IDEs.

*Note: The similar project for Blender Game Engine (BGE) is available on [fake-bge-module](https://github.com/nutti/fake-bge-module) which targets [UPBGE](https://upbge.org/).*

![](docs/images/fake-bpy-module_thumbnail.png)


## Requirements

fake-bpy-module uses typing module and type hints which are available from Python 3.7.
Check your Python version is >= 3.7.


## Install

fake-bpy-module can be installed via a pip package, or pre-generated modules.
You can also generate and install modules manually.


### Install via pip package

fake-bpy-module is registered to PyPI.  
You can install it as a pip package.

```sh
pip install fake-bpy-module-<version>
```

If you install fake-bpy-module for Blender 2.93, run below command.

```sh
pip install fake-bpy-module-2.93
```

If you install fake-bpy-module for Blender latest build (master branch daily build powered by [nutti/blender-daily-build](https://github.com/nutti/blender-daily-build)), run below command.

```sh
pip install fake-bpy-module-latest
```

*Note: For PyCharm users, change the value `idea.max.intellisense.filesize` in `idea.properties` file to more than 2600 because some modules have the issue of being too big for intelliSense to work.*

#### Supported Blender Version

|Version|PyPI|
|---|---|
|2.78|https://pypi.org/project/fake-bpy-module-2.78/|
|2.79|https://pypi.org/project/fake-bpy-module-2.79/|
|2.80|https://pypi.org/project/fake-bpy-module-2.80/|
|2.81|https://pypi.org/project/fake-bpy-module-2.81/|
|2.82|https://pypi.org/project/fake-bpy-module-2.82/|
|2.83|https://pypi.org/project/fake-bpy-module-2.83/|
|2.90|https://pypi.org/project/fake-bpy-module-2.90/|
|2.91|https://pypi.org/project/fake-bpy-module-2.91/|
|2.92|https://pypi.org/project/fake-bpy-module-2.92/|
|2.93|https://pypi.org/project/fake-bpy-module-2.93/|
|3.0|https://pypi.org/project/fake-bpy-module-3.0/|
|latest|https://pypi.org/project/fake-bpy-module-latest/|


### Install via pre-generated modules

Download Pre-generated modules from [Release page](https://github.com/nutti/fake-bpy-module/releases).

The process of installation via pre-generated modules is different by IDE.
See the installation processes as follows for detail.

* [PyCharm](docs/setup_pycharm.md)
* [Visual Studio Code](docs/setup_visual_studio_code.md)
* [All Text Editor (Install as Python module)](docs/setup_all_text_editor.md)


### Generate Modules Manually

You can also generate modules manually.
See [Generate Module](docs/generate_modules.md) for detail.


## Change Log

See [CHANGELOG.md](CHANGELOG.md)


## Bug report / Feature request / Disscussions

If you want to report bug, request features or discuss about this add-on, see [ISSUES.md](ISSUES.md).

[fake-bpy-module](https://blender.chat/channel/fake-bpy-module) channel is available on [blender.chat](https://blender.chat/).  
The timely discussion and release announcement about fake-bpy-module will be made in this channel.

*Note: Registration of blender.chat is required for accessing fake-bpy-module channel.*


## Contribution

If you want to contribute to this project, see [CONTRIBUTING.md](CONTRIBUTING.md).


## Project Authors


### Owner

[**@nutti**](https://github.com/nutti)

Indie Game/Application Developer.  
Especially, I spend most time to improve Blender and Unreal Game Engine via providing the extensions.

Support via [GitHub Sponsors](https://github.com/sponsors/nutti)

* CONTACTS: [Twitter](https://twitter.com/nutti__)
* WEBSITE: [Japanese Only](https://colorful-pico.net/)


### Contributors

* [**@grische**](https://github.com/grische)
* [**@echantry**](https://github.com/echantry)
* [**@kant**](https://github.com/kant)