fake-bpy-module


Namefake-bpy-module JSON
Version 20240907 PyPI version JSON
download
home_pageNone
SummaryCollection of the fake Blender Python API module for the code completion.
upload_time2024-09-07 06:17:08
maintainernutti
docs_urlNone
authornutti
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # 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/).

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

*To realize the long support of this project, your support is helpful.*
*You can support the development of this project via*
**[GitHub Sponsors](https://github.com/sponsors/nutti)**.
*See [the contribution document](CONTRIBUTING.md) for the detail of*
*the support.*

## Requirements

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

## 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.

#### Install a latest package

If you install fake-bpy-module for Blender latest build (main 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
```

or, specify version "latest".

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

#### Install a version specific package

If you want to install a version specific package, run below command.

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

*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/](https://pypi.org/project/fake-bpy-module-2.78/)|
|2.79|[https://pypi.org/project/fake-bpy-module-2.79/](https://pypi.org/project/fake-bpy-module-2.79/)|
|2.80|[https://pypi.org/project/fake-bpy-module-2.80/](https://pypi.org/project/fake-bpy-module-2.80/)|
|2.81|[https://pypi.org/project/fake-bpy-module-2.81/](https://pypi.org/project/fake-bpy-module-2.81/)|
|2.82|[https://pypi.org/project/fake-bpy-module-2.82/](https://pypi.org/project/fake-bpy-module-2.82/)|
|2.83|[https://pypi.org/project/fake-bpy-module-2.83/](https://pypi.org/project/fake-bpy-module-2.83/)|
|2.90|[https://pypi.org/project/fake-bpy-module-2.90/](https://pypi.org/project/fake-bpy-module-2.90/)|
|2.91|[https://pypi.org/project/fake-bpy-module-2.91/](https://pypi.org/project/fake-bpy-module-2.91/)|
|2.92|[https://pypi.org/project/fake-bpy-module-2.92/](https://pypi.org/project/fake-bpy-module-2.92/)|
|2.93|[https://pypi.org/project/fake-bpy-module-2.93/](https://pypi.org/project/fake-bpy-module-2.93/)|
|3.0|[https://pypi.org/project/fake-bpy-module-3.0/](https://pypi.org/project/fake-bpy-module-3.0/)|
|3.1|[https://pypi.org/project/fake-bpy-module-3.1/](https://pypi.org/project/fake-bpy-module-3.1/)|
|3.2|[https://pypi.org/project/fake-bpy-module-3.2/](https://pypi.org/project/fake-bpy-module-3.2/)|
|3.3|[https://pypi.org/project/fake-bpy-module-3.3/](https://pypi.org/project/fake-bpy-module-3.3/)|
|3.4|[https://pypi.org/project/fake-bpy-module-3.4/](https://pypi.org/project/fake-bpy-module-3.4/)|
|3.5|[https://pypi.org/project/fake-bpy-module-3.5/](https://pypi.org/project/fake-bpy-module-3.5/)|
|3.6|[https://pypi.org/project/fake-bpy-module-3.6/](https://pypi.org/project/fake-bpy-module-3.6/)|
|4.0|[https://pypi.org/project/fake-bpy-module-4.0/](https://pypi.org/project/fake-bpy-module-4.0/)|
|4.1|[https://pypi.org/project/fake-bpy-module-4.1/](https://pypi.org/project/fake-bpy-module-4.1/)|
|4.2|[https://pypi.org/project/fake-bpy-module-4.2/](https://pypi.org/project/fake-bpy-module-4.2/)|
|latest|[https://pypi.org/project/fake-bpy-module/](https://pypi.org/project/fake-bpy-module/)|
||[https://pypi.org/project/fake-bpy-module-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 project, see
[ISSUES.md](ISSUES.md).

[fake-bpy-module channel](https://discord.gg/dGU9et5S2d) is
available on the Discord server.  
The timely discussion and release announcement about fake-bpy-module will be
made in this 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)
* [**@theoryshaw**](https://github.com/theoryshaw)
* [**@espiondev**](https://github.com/espiondev)
* [**@JonathanPlasse**](https://github.com/JonathanPlasse)
* [**@UuuNyaa**](https://github.com/UuuNyaa)
* [**@Road-hog123**](https://github.com/Road-hog123)
* [**@Andrej730**](https://github.com/Andrej730)

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "fake-bpy-module",
    "maintainer": "nutti",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "nutti.metro@gmail.com",
    "keywords": null,
    "author": "nutti",
    "author_email": "nutti.metro@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/77/9f/fe9732f9ada9afb08ad9135e49b27c07d6408ff537d723c12858c84bbd40/fake_bpy_module-20240907.tar.gz",
    "platform": "Windows",
    "description": "# Fake Blender Python API module collection: fake-bpy-module\n\nfake-bpy-module is the collections of the fake Blender Python API modules for\nthe code completion in commonly used IDEs.\n\nNote: The similar project for Blender Game Engine (BGE) is available on\n[fake-bge-module](https://github.com/nutti/fake-bge-module) which targets\n[UPBGE](https://upbge.org/).\n\n![fake-bpy-module Thumbnail](docs/images/fake-bpy-module_thumbnail.png)\n\n*To realize the long support of this project, your support is helpful.*\n*You can support the development of this project via*\n**[GitHub Sponsors](https://github.com/sponsors/nutti)**.\n*See [the contribution document](CONTRIBUTING.md) for the detail of*\n*the support.*\n\n## Requirements\n\nfake-bpy-module uses typing module and type hints which are available from\nPython 3.8. Check your Python version is >= 3.8.\n\n## Install\n\nfake-bpy-module can be installed via a pip package, or pre-generated modules.\nYou can also generate and install modules manually.\n\n### Install via pip package\n\nfake-bpy-module is registered to PyPI.  \nYou can install it as a pip package.\n\n#### Install a latest package\n\nIf you install fake-bpy-module for Blender latest build (main branch daily\nbuild powered by [nutti/blender-daily-build](https://github.com/nutti/blender-daily-build)),\nrun below command.\n\n```sh\npip install fake-bpy-module\n```\n\nor, specify version \"latest\".\n\n```sh\npip install fake-bpy-module-latest\n```\n\n#### Install a version specific package\n\nIf you want to install a version specific package, run below command.\n\n```sh\npip install fake-bpy-module-<version>\n```\n\nIf you install fake-bpy-module for Blender 2.93, run below command.\n\n```sh\npip install fake-bpy-module-2.93\n```\n\n*Note: For PyCharm users, change the value `idea.max.intellisense.filesize` in\n`idea.properties` file to more than 2600 because some modules have the issue of\nbeing too big for intelliSense to work.*\n\n##### Supported Blender Version\n\n|Version|PyPI|\n|---|---|\n|2.78|[https://pypi.org/project/fake-bpy-module-2.78/](https://pypi.org/project/fake-bpy-module-2.78/)|\n|2.79|[https://pypi.org/project/fake-bpy-module-2.79/](https://pypi.org/project/fake-bpy-module-2.79/)|\n|2.80|[https://pypi.org/project/fake-bpy-module-2.80/](https://pypi.org/project/fake-bpy-module-2.80/)|\n|2.81|[https://pypi.org/project/fake-bpy-module-2.81/](https://pypi.org/project/fake-bpy-module-2.81/)|\n|2.82|[https://pypi.org/project/fake-bpy-module-2.82/](https://pypi.org/project/fake-bpy-module-2.82/)|\n|2.83|[https://pypi.org/project/fake-bpy-module-2.83/](https://pypi.org/project/fake-bpy-module-2.83/)|\n|2.90|[https://pypi.org/project/fake-bpy-module-2.90/](https://pypi.org/project/fake-bpy-module-2.90/)|\n|2.91|[https://pypi.org/project/fake-bpy-module-2.91/](https://pypi.org/project/fake-bpy-module-2.91/)|\n|2.92|[https://pypi.org/project/fake-bpy-module-2.92/](https://pypi.org/project/fake-bpy-module-2.92/)|\n|2.93|[https://pypi.org/project/fake-bpy-module-2.93/](https://pypi.org/project/fake-bpy-module-2.93/)|\n|3.0|[https://pypi.org/project/fake-bpy-module-3.0/](https://pypi.org/project/fake-bpy-module-3.0/)|\n|3.1|[https://pypi.org/project/fake-bpy-module-3.1/](https://pypi.org/project/fake-bpy-module-3.1/)|\n|3.2|[https://pypi.org/project/fake-bpy-module-3.2/](https://pypi.org/project/fake-bpy-module-3.2/)|\n|3.3|[https://pypi.org/project/fake-bpy-module-3.3/](https://pypi.org/project/fake-bpy-module-3.3/)|\n|3.4|[https://pypi.org/project/fake-bpy-module-3.4/](https://pypi.org/project/fake-bpy-module-3.4/)|\n|3.5|[https://pypi.org/project/fake-bpy-module-3.5/](https://pypi.org/project/fake-bpy-module-3.5/)|\n|3.6|[https://pypi.org/project/fake-bpy-module-3.6/](https://pypi.org/project/fake-bpy-module-3.6/)|\n|4.0|[https://pypi.org/project/fake-bpy-module-4.0/](https://pypi.org/project/fake-bpy-module-4.0/)|\n|4.1|[https://pypi.org/project/fake-bpy-module-4.1/](https://pypi.org/project/fake-bpy-module-4.1/)|\n|4.2|[https://pypi.org/project/fake-bpy-module-4.2/](https://pypi.org/project/fake-bpy-module-4.2/)|\n|latest|[https://pypi.org/project/fake-bpy-module/](https://pypi.org/project/fake-bpy-module/)|\n||[https://pypi.org/project/fake-bpy-module-latest/](https://pypi.org/project/fake-bpy-module-latest/)|\n\n### Install via pre-generated modules\n\nDownload Pre-generated modules from [Release page](https://github.com/nutti/fake-bpy-module/releases).\n\nThe process of installation via pre-generated modules is different by IDE.\nSee the installation processes as follows for detail.\n\n* [PyCharm](docs/setup_pycharm.md)\n* [Visual Studio Code](docs/setup_visual_studio_code.md)\n* [All Text Editor (Install as Python module)](docs/setup_all_text_editor.md)\n\n### Generate Modules Manually\n\nYou can also generate modules manually.\nSee [Generate Module](docs/generate_modules.md) for detail.\n\n## Change Log\n\nSee [CHANGELOG.md](CHANGELOG.md)\n\n## Bug report / Feature request / Disscussions\n\nIf you want to report bug, request features or discuss about this project, see\n[ISSUES.md](ISSUES.md).\n\n[fake-bpy-module channel](https://discord.gg/dGU9et5S2d) is\navailable on the Discord server.  \nThe timely discussion and release announcement about fake-bpy-module will be\nmade in this channel.\n\n## Contribution\n\nIf you want to contribute to this project, see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## Project Authors\n\n### Owner\n\n[**@nutti**](https://github.com/nutti)\n\nIndie Game/Application Developer.  \nEspecially, I spend most time to improve Blender and Unreal Game Engine via\nproviding the extensions.\n\nSupport via [GitHub Sponsors](https://github.com/sponsors/nutti)\n\n* CONTACTS: [Twitter](https://twitter.com/nutti__)\n* WEBSITE: [Japanese Only](https://colorful-pico.net/)\n\n### Contributors\n\n* [**@grische**](https://github.com/grische)\n* [**@echantry**](https://github.com/echantry)\n* [**@kant**](https://github.com/kant)\n* [**@theoryshaw**](https://github.com/theoryshaw)\n* [**@espiondev**](https://github.com/espiondev)\n* [**@JonathanPlasse**](https://github.com/JonathanPlasse)\n* [**@UuuNyaa**](https://github.com/UuuNyaa)\n* [**@Road-hog123**](https://github.com/Road-hog123)\n* [**@Andrej730**](https://github.com/Andrej730)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Collection of the fake Blender Python API module for the code completion.",
    "version": "20240907",
    "project_urls": {
        "Bug Tracker": "https://github.com/nutti/fake-bpy-module/issues",
        "Documentation": "https://github.com/nutti/fake-bpy-module/blob/main/README.md",
        "Download": "https://github.com/nutti/fake-bpy-module/releases",
        "Homepage": "https://github.com/nutti/fake-bpy-module",
        "Release Notes": "https://github.com/nutti/fake-bpy-module/blob/main/CHANGELOG.md",
        "Source": "https://github.com/nutti/fake-bpy-module"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "31170e26e83c67233701a31d4338d6fa6805d1b64df258556704aebd96246bb5",
                "md5": "f8a090073398fa1f82088a665740d609",
                "sha256": "6d39b5a7d78ebd5421dd3ec272f605896fe964a77ff869b0cd7be53a366341fb"
            },
            "downloads": -1,
            "filename": "fake_bpy_module-20240907-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f8a090073398fa1f82088a665740d609",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 1244221,
            "upload_time": "2024-09-07T06:17:06",
            "upload_time_iso_8601": "2024-09-07T06:17:06.706816Z",
            "url": "https://files.pythonhosted.org/packages/31/17/0e26e83c67233701a31d4338d6fa6805d1b64df258556704aebd96246bb5/fake_bpy_module-20240907-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "779ffe9732f9ada9afb08ad9135e49b27c07d6408ff537d723c12858c84bbd40",
                "md5": "75accbee4304e6141d903e25280787a7",
                "sha256": "d2c110ce1099c6b64552170da7b5ca493741950ff942c97200258e5c13312cc2"
            },
            "downloads": -1,
            "filename": "fake_bpy_module-20240907.tar.gz",
            "has_sig": false,
            "md5_digest": "75accbee4304e6141d903e25280787a7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 1109212,
            "upload_time": "2024-09-07T06:17:08",
            "upload_time_iso_8601": "2024-09-07T06:17:08.484834Z",
            "url": "https://files.pythonhosted.org/packages/77/9f/fe9732f9ada9afb08ad9135e49b27c07d6408ff537d723c12858c84bbd40/fake_bpy_module-20240907.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-07 06:17:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nutti",
    "github_project": "fake-bpy-module",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "fake-bpy-module"
}
nutti
Elapsed time: 0.38638s