├── .containers ├── Dockerfile ├── FreeBSD │ ├── install.sh │ └── jail.conf └── OmniOS │ ├── install.sh │ └── zone.conf ├── .dockerignore ├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md └── workflows │ └── pythonpackage.yml ├── .gitignore ├── .gitmodules ├── .travis.yml ├── .vscode ├── launch.json ├── settings.json ├── tasks.json └── tasks │ └── Docker │ ├── manylinux │ ├── build.sh │ ├── build_wheels.sh │ └── update_python_requirements.sh │ └── windows │ ├── build.sh │ └── build_wheels.sh ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── MANIFEST.in ├── README.md ├── blenderpy ├── __init__.py ├── post_install.py └── pre_uninstall.py ├── docker-compose.yaml ├── requirements.txt ├── setup.py └── tests ├── test_bpy.py └── test_concurrent_futures.py /.containers/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM quay.io/pypa/manylinux2014_x86_64 AS blenderpy-manylinux-wheel-builder 2 | 3 | RUN yum-config-manager --add-repo https://developer.download.nvidia.com/compute/cuda/repos/rhel7/x86_64/cuda-rhel7.repo && \ 4 | yum -y clean all 5 | 6 | RUN yum -y install \ 7 | centos-release-scl \ 8 | cuda-toolkit-10-1.x86_64 \ 9 | gcc \ 10 | gcc-c++ \ 11 | git \ 12 | glew-devel \ 13 | libffi-devel \ 14 | libX11-devel \ 15 | libXcursor-devel \ 16 | libXi-devel \ 17 | libXinerama-devel \ 18 | libxml2-devel \ 19 | libXrandr-devel \ 20 | make \ 21 | openssl-devel \ 22 | subversion && \ 23 | yum -y clean all 24 | RUN yum -y install devtoolset-7 && \ 25 | yum -y clean all 26 | # installs to /opt/rh/devtoolset-7/root/bin/gcc 27 | # NVIDIA needs gcc < 8 since CUDA version is 10 28 | RUN ln -sf /opt/rh/devtoolset-7/root/bin/gcc /usr/local/cuda/bin/gcc 29 | 30 | ADD https://github.com/Kitware/CMake/releases/download/v3.17.3/cmake-3.17.3-Linux-x86_64.tar.gz cmake-3.17.3-Linux-x86_64.tar.gz 31 | RUN tar xzf cmake-3.17.3-Linux-x86_64.tar.gz 32 | ENV PATH="/blenderpy/cmake-3.17.3-Linux-x86_64/bin:${PATH}" 33 | 34 | COPY . /blenderpy 35 | 36 | RUN /blenderpy/Optix/NVIDIA-OptiX-SDK-7.1.0-linux64-x86_64.sh --include-subdir --skip-license 37 | 38 | RUN /blenderpy/.vscode/tasks/Docker/manylinux/update_python_requirements.sh 39 | 40 | FROM winamd64/python:3.7.9-windowsservercore-1809 AS blenderpy-windows-wheel-builder 41 | 42 | # Restore the default Windows shell for correct batch processing. 43 | SHELL ["cmd", "/S", "/C"] 44 | 45 | # Download the Build Tools bootstrapper. 46 | ADD https://aka.ms/vs/16/release/vs_buildtools.exe vs_buildtools.exe 47 | 48 | # Install Build Tools with the Microsoft.VisualStudio.Workload.AzureBuildTools workload, excluding workloads and components with known issues. 49 | RUN vs_buildtools.exe --quiet --wait --norestart --nocache \ 50 | --installPath "C:\BuildTools" \ 51 | --add Microsoft.VisualStudio.Workload.AzureBuildTools \ 52 | --remove Microsoft.VisualStudio.Component.Windows10SDK.10240 \ 53 | --remove Microsoft.VisualStudio.Component.Windows10SDK.10586 \ 54 | --remove Microsoft.VisualStudio.Component.Windows10SDK.14393 \ 55 | --remove Microsoft.VisualStudio.Component.Windows81SDK \ 56 | || IF "%ERRORLEVEL%"=="3010" EXIT 0 57 | 58 | ADD https://www.python.org/ftp/python/3.7.7/Python-3.7.7.tgz Python-3.7.7.tgz 59 | RUN tar xzf Python-3.7.7.tgz 60 | RUN cd Python-3.7.7 && \ 61 | ./configure --enable-optimizations 62 | RUN cd Python-3.7.7 && \ 63 | make install 64 | 65 | RUN py -m pip install -U pip 66 | 67 | COPY . /blenderpy 68 | 69 | RUN py -m pip install -r requirements.txt 70 | RUN cp /blenderpy/bpy/setup.py /blenderpy 71 | RUN py -m pip install . -v 72 | 73 | CMD py -c "import bpy" -------------------------------------------------------------------------------- /.containers/FreeBSD/install.sh: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TylerGubala/blenderpy/0f8a21a83ad1a17e2adc5ee72140accd7a1e3eac/.containers/FreeBSD/install.sh -------------------------------------------------------------------------------- /.containers/FreeBSD/jail.conf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TylerGubala/blenderpy/0f8a21a83ad1a17e2adc5ee72140accd7a1e3eac/.containers/FreeBSD/jail.conf -------------------------------------------------------------------------------- /.containers/OmniOS/install.sh: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TylerGubala/blenderpy/0f8a21a83ad1a17e2adc5ee72140accd7a1e3eac/.containers/OmniOS/install.sh -------------------------------------------------------------------------------- /.containers/OmniOS/zone.conf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TylerGubala/blenderpy/0f8a21a83ad1a17e2adc5ee72140accd7a1e3eac/.containers/OmniOS/zone.conf -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | # no point in copying .containers directory 2 | .containers/ 3 | .github/ 4 | .travis/ 5 | Blender/ 6 | 7 | # VSCode stuff people will probably find annoying 8 | .vscode/settings.json 9 | 10 | # logs 11 | logs/ 12 | 13 | # Byte-compiled / optimized / DLL files 14 | __pycache__/ 15 | *.py[cod] 16 | *$py.class 17 | 18 | # C extensions 19 | *.so 20 | 21 | # Distribution / packaging 22 | .Python 23 | env/ 24 | build/ 25 | develop-eggs/ 26 | dist/ 27 | downloads/ 28 | eggs/ 29 | .eggs/ 30 | lib/ 31 | lib64/ 32 | parts/ 33 | sdist/ 34 | var/ 35 | wheels/ 36 | *.egg-info/ 37 | .installed.cfg 38 | *.egg 39 | 40 | # PyInstaller 41 | # Usually these files are written by a python script from a template 42 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 43 | *.manifest 44 | *.spec 45 | 46 | # Installer logs 47 | pip-log.txt 48 | pip-delete-this-directory.txt 49 | 50 | # Unit test / coverage reports 51 | htmlcov/ 52 | .tox/ 53 | .coverage 54 | .coverage.* 55 | .cache 56 | nosetests.xml 57 | coverage.xml 58 | *.cover 59 | .hypothesis/ 60 | 61 | # Translations 62 | *.mo 63 | *.pot 64 | 65 | # Django stuff: 66 | *.log 67 | local_settings.py 68 | 69 | # Flask stuff: 70 | instance/ 71 | .webassets-cache 72 | 73 | # Scrapy stuff: 74 | .scrapy 75 | 76 | # Sphinx documentation 77 | docs/_build/ 78 | 79 | # PyBuilder 80 | target/ 81 | 82 | # Jupyter Notebook 83 | .ipynb_checkpoints 84 | 85 | # pyenv 86 | .python-version 87 | 88 | # celery beat schedule file 89 | celerybeat-schedule 90 | 91 | # SageMath parsed files 92 | *.sage.py 93 | 94 | # dotenv 95 | .env 96 | 97 | # virtualenv 98 | .venv 99 | venv/ 100 | ENV/ 101 | 102 | # Spyder project settings 103 | .spyderproject 104 | .spyproject 105 | 106 | # Rope project settings 107 | .ropeproject 108 | 109 | # mkdocs documentation 110 | /site 111 | 112 | # mypy 113 | .mypy_cache/ 114 | 115 | .pypirc 116 | 117 | # Automatically generated directory 118 | /%BUILD_DIR% 119 | 120 | # Logs generated by my vscode commands 121 | /logs -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [TylerGubala] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: ['https://www.paypal.com/paypalme/tylergubala'] 13 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Desktop (please complete the following information):** 27 | - OS: [e.g. iOS] 28 | - Browser [e.g. chrome, safari] 29 | - Version [e.g. 22] 30 | 31 | **Smartphone (please complete the following information):** 32 | - Device: [e.g. iPhone6] 33 | - OS: [e.g. iOS8.1] 34 | - Browser [e.g. stock browser, safari] 35 | - Version [e.g. 22] 36 | 37 | **Additional context** 38 | Add any other context about the problem here. 39 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/workflows/pythonpackage.yml: -------------------------------------------------------------------------------- 1 | # This workflow will install Python dependencies, run tests and lint with a variety of Python versions 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions 3 | 4 | name: Python package 5 | 6 | on: 7 | push: 8 | branches: [ master ] 9 | pull_request: 10 | branches: [ master ] 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | strategy: 17 | matrix: 18 | python-version: [3.7] 19 | 20 | steps: 21 | - uses: actions/checkout@v2 22 | - name: Set up Python ${{ matrix.python-version }} 23 | uses: actions/setup-python@v2 24 | with: 25 | python-version: ${{ matrix.python-version }} 26 | - name: Install dependencies 27 | run: | 28 | python -m pip install --upgrade pip 29 | pip install flake8 pytest wheel 30 | if [ -f requirements.txt ]; then pip install -r requirements.txt; fi 31 | - name: Build Blender and bpy 32 | run: | 33 | pip3 install . 34 | - name: Lint with flake8 35 | run: | 36 | # stop the build if there are Python syntax errors or undefined names 37 | flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics 38 | # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide 39 | flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics 40 | - name: Test with pytest 41 | run: | 42 | pytest 43 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Docker uses source code located at `./Blender/` for build 2 | Blender/lib/ 3 | 4 | # To build with optix support we need the linux optix installer here 5 | Optix/ 6 | 7 | # VSCode stuff people will probably find annoying 8 | .vscode/settings.json 9 | 10 | # logs 11 | logs/ 12 | 13 | # Byte-compiled / optimized / DLL files 14 | __pycache__/ 15 | *.py[cod] 16 | *$py.class 17 | 18 | # C extensions 19 | *.so 20 | 21 | # Distribution / packaging 22 | .Python 23 | env/ 24 | build/ 25 | develop-eggs/ 26 | dist/ 27 | downloads/ 28 | eggs/ 29 | .eggs/ 30 | lib/ 31 | lib64/ 32 | parts/ 33 | sdist/ 34 | var/ 35 | wheels/ 36 | *.egg-info/ 37 | .installed.cfg 38 | *.egg 39 | 40 | # PyInstaller 41 | # Usually these files are written by a python script from a template 42 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 43 | *.manifest 44 | *.spec 45 | 46 | # Installer logs 47 | pip-log.txt 48 | pip-delete-this-directory.txt 49 | 50 | # Unit test / coverage reports 51 | htmlcov/ 52 | .tox/ 53 | .coverage 54 | .coverage.* 55 | .cache 56 | nosetests.xml 57 | coverage.xml 58 | *.cover 59 | .hypothesis/ 60 | 61 | # Translations 62 | *.mo 63 | *.pot 64 | 65 | # Django stuff: 66 | *.log 67 | local_settings.py 68 | 69 | # Flask stuff: 70 | instance/ 71 | .webassets-cache 72 | 73 | # Scrapy stuff: 74 | .scrapy 75 | 76 | # Sphinx documentation 77 | docs/_build/ 78 | 79 | # PyBuilder 80 | target/ 81 | 82 | # Jupyter Notebook 83 | .ipynb_checkpoints 84 | 85 | # pyenv 86 | .python-version 87 | 88 | # celery beat schedule file 89 | celerybeat-schedule 90 | 91 | # SageMath parsed files 92 | *.sage.py 93 | 94 | # dotenv 95 | .env 96 | 97 | # virtualenv 98 | .venv 99 | venv/ 100 | venvs/ 101 | ENV/ 102 | 103 | # Spyder project settings 104 | .spyderproject 105 | .spyproject 106 | 107 | # Rope project settings 108 | .ropeproject 109 | 110 | # mkdocs documentation 111 | /site 112 | 113 | # mypy 114 | .mypy_cache/ 115 | 116 | .pypirc 117 | 118 | # Automatically generated directory 119 | /%BUILD_DIR% 120 | 121 | # Logs generated by my vscode commands 122 | /logs -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "Blender/blender"] 2 | path = Blender/blender 3 | url = https://git.blender.org/blender.git 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | 3 | notifications: 4 | email: false 5 | 6 | jobs: 7 | include: 8 | - os: osx 9 | osx_image: xcode12.2 10 | language: generic 11 | env: TOXENV=py37 12 | 13 | before_install: 14 | - if [ $TRAVIS_OS_NAME = 'osx' ]; then brew install svn; fi 15 | - if [ $TRAVIS_OS_NAME = 'osx' ]; then mkdir -p build/darwin; fi 16 | - if [ $TRAVIS_OS_NAME = 'linux' ]; then apt -y install build-essential git subversion cmake libx11-dev libxxf86vm-dev libxcursor-dev libxi-dev libxrandr-dev libxinerama-dev libglew-dev; fi 17 | - if [ $TRAVIS_OS_NAME = 'linux' ]; then mkdir -p build/linux; fi 18 | - cd Blender/blender && chmod u+x ./make.sh && ./make.sh update 19 | 20 | install: 21 | - if [ $TRAVIS_OS_NAME = 'osx' ]; then cd ../../build/darwin && cmake ../../Blender/blender -DWITH_PYTHON_INSTALL=OFF -DWITH_PYTHON_MODULE=ON -DWITH_MEM_JEMALLOC=OFF && ./make install -j$((`nproc`+1)); fi 22 | - if [ $TRAVIS_OS_NAME = 'linux' ]; then cd ../../build/linux && cmake ../../Blender/blender -DWITH_PYTHON_INSTALL=OFF -DWITH_PYTHON_MODULE=ON -DWITH_MEM_JEMALLOC=OFF && ./make install -j$((`nproc`+1)); fi 23 | 24 | script: 25 | - chmod u+x .travis/script.sh 26 | - .travis/script.sh -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | // Use IntelliSense to learn about possible attributes. 3 | // Hover to view descriptions of existing attributes. 4 | // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 5 | "version": "0.2.0", 6 | "configurations": [ 7 | 8 | { 9 | "name": "Python: Current File", 10 | "type": "python", 11 | "request": "launch", 12 | "program": "${file}" 13 | }, 14 | { 15 | "name": "Install package", 16 | "type": "python", 17 | "request": "launch", 18 | "program": "${file}", 19 | "args": [ 20 | "install" 21 | ] 22 | }, 23 | { 24 | "name": "Python: Attach", 25 | "type": "python", 26 | "request": "attach", 27 | "localRoot": "${workspaceFolder}", 28 | "remoteRoot": "${workspaceFolder}", 29 | "port": 3000, 30 | "secret": "my_secret", 31 | "host": "localhost" 32 | }, 33 | { 34 | "name": "Python: Terminal (integrated)", 35 | "type": "python", 36 | "request": "launch", 37 | "program": "${file}", 38 | "console": "integratedTerminal" 39 | }, 40 | { 41 | "name": "Python: Terminal (external)", 42 | "type": "python", 43 | "request": "launch", 44 | "program": "${file}", 45 | "console": "externalTerminal" 46 | }, 47 | { 48 | "name": "Python: Django", 49 | "type": "python", 50 | "request": "launch", 51 | "program": "${workspaceFolder}/manage.py", 52 | "args": [ 53 | "runserver", 54 | "--noreload", 55 | "--nothreading" 56 | ], 57 | "debugOptions": [ 58 | "RedirectOutput", 59 | "Django" 60 | ] 61 | }, 62 | { 63 | "name": "Python: Flask (0.11.x or later)", 64 | "type": "python", 65 | "request": "launch", 66 | "module": "flask", 67 | "env": { 68 | "FLASK_APP": "${workspaceFolder}/app.py" 69 | }, 70 | "args": [ 71 | "run", 72 | "--no-debugger", 73 | "--no-reload" 74 | ] 75 | }, 76 | { 77 | "name": "Python: Module", 78 | "type": "python", 79 | "request": "launch", 80 | "module": "module.name" 81 | }, 82 | { 83 | "name": "Python: Pyramid", 84 | "type": "python", 85 | "request": "launch", 86 | "args": [ 87 | "${workspaceFolder}/development.ini" 88 | ], 89 | "debugOptions": [ 90 | "RedirectOutput", 91 | "Pyramid" 92 | ] 93 | }, 94 | { 95 | "name": "Python: Watson", 96 | "type": "python", 97 | "request": "launch", 98 | "program": "${workspaceFolder}/console.py", 99 | "args": [ 100 | "dev", 101 | "runserver", 102 | "--noreload=True" 103 | ] 104 | }, 105 | { 106 | "name": "Python: All debug Options", 107 | "type": "python", 108 | "request": "launch", 109 | "python": "${command:python.interpreterPath}", 110 | "program": "${file}", 111 | "module": "module.name", 112 | "env": { 113 | "VAR1": "1", 114 | "VAR2": "2" 115 | }, 116 | "envFile": "${workspaceFolder}/.env", 117 | "args": [ 118 | "arg1", 119 | "arg2" 120 | ], 121 | "debugOptions": [ 122 | "RedirectOutput" 123 | ] 124 | } 125 | ] 126 | } -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "python.venvPath": "${workspaceFolder}\\venv", 3 | "python.pythonPath": "venv\\3.7-64\\Scripts\\python.exe", 4 | "svn.multipleFolders.depth": 10 5 | } -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | // See https://go.microsoft.com/fwlink/?LinkId=733558 3 | // for the documentation about the tasks.json format 4 | "version": "2.0.0", 5 | "tasks": [ 6 | { 7 | "label": "Delete Python Build Folder", 8 | "type": "shell", 9 | "linux": { 10 | "command": "rm", 11 | "args": [ 12 | "-Rf", 13 | "${workspaceFolder}/build" 14 | ] 15 | }, 16 | "osx": { 17 | "command": "rm", 18 | "args": [ 19 | "-Rf", 20 | "${workspaceFolder}/build" 21 | ] 22 | }, 23 | "windows": { 24 | "command": "Remove-Item", 25 | "args": [ 26 | "-Recurse", 27 | "-Force", 28 | "-Path", 29 | "${workspaceFolder}\\build" 30 | ] 31 | } 32 | }, 33 | { 34 | "label": "Delete Python Distribution Folder", 35 | "type": "shell", 36 | "linux": { 37 | "command": "rm", 38 | "args": [ 39 | "-Rf", 40 | "${workspaceFolder}/dist" 41 | ] 42 | }, 43 | "osx": { 44 | "command": "rm", 45 | "args": [ 46 | "-Rf", 47 | "${workspaceFolder}/dist" 48 | ] 49 | }, 50 | "windows": { 51 | "command": "Remove-Item", 52 | "args": [ 53 | "-Recurse", 54 | "-Force", 55 | "-Path", 56 | "${workspaceFolder}\\dist" 57 | ] 58 | } 59 | }, 60 | { 61 | "label": "Delete Blender Build Folder", 62 | "type": "shell", 63 | "linux": { 64 | "command": "rm", 65 | "args": [ 66 | "-Rf", 67 | "${workspaceFolder}/Blender/build" 68 | ] 69 | }, 70 | "osx": { 71 | "command": "rm", 72 | "args": [ 73 | "-Rf", 74 | "${workspaceFolder}/Blender/build" 75 | ] 76 | }, 77 | "windows": { 78 | "command": "Remove-Item", 79 | "args": [ 80 | "-Recurse", 81 | "-Force", 82 | "-Path", 83 | "${workspaceFolder}\\Blender\\build" 84 | ] 85 | } 86 | }, 87 | { 88 | "label": "Clean Blender Build Folder", 89 | "dependsOn": [ 90 | "Delete Blender Build Folder", 91 | "Make Blender Build Folder" 92 | ], 93 | "dependsOrder": "sequence", 94 | "problemMatcher": [] 95 | }, 96 | { 97 | "label": "Python - Build Local Wheel File From Sources", 98 | "type": "shell", 99 | "command": "${config:python.pythonPath}", 100 | "args": [ 101 | "setup.py", 102 | "bdist_wheel" 103 | ], 104 | "dependsOn": [ 105 | "Delete Python Build Folder" 106 | ], 107 | "problemMatcher": [] 108 | }, 109 | { 110 | "label": "Python - Build Source Distribution", 111 | "type": "shell", 112 | "command": "${config:python.pythonPath}", 113 | "args": [ 114 | "setup.py", 115 | "sdist" 116 | ], 117 | "dependsOn": [ 118 | "Delete Python Build Folder" 119 | ], 120 | "problemMatcher": [] 121 | }, 122 | { 123 | "label": "Python - Build Local Wheel File From Prebuilt Binaries", 124 | "type": "shell", 125 | "linux": { 126 | "command": "${config:python.pythonPath}", 127 | "args": [ 128 | "setup.py", 129 | "bdist_wheel", 130 | "--bpy-prebuilt=${workspaceFolder}/Blender/build/linux/bin/" 131 | ] 132 | }, 133 | "osx": { 134 | "command": "${config:python.pythonPath}", 135 | "args": [ 136 | "setup.py", 137 | "bdist_wheel", 138 | "--bpy-prebuilt=${workspaceFolder}/Blender/build/darwin/bin/" 139 | ] 140 | }, 141 | "windows": { 142 | "command": "${config:python.pythonPath}", 143 | "args": [ 144 | "setup.py", 145 | "bdist_wheel", 146 | "--bpy-prebuilt=${workspaceFolder}/Blender/build/windows/bin/Release" 147 | ] 148 | }, 149 | "dependsOn": [ 150 | "Delete Python Build Folder" 151 | ], 152 | "problemMatcher": [] 153 | }, 154 | { 155 | "label": "Python - Twine Upload to PyPI", 156 | "type": "process", 157 | "command": "${config:python.pythonPath}", 158 | "args": [ 159 | "-m", 160 | "twine", 161 | "upload", 162 | "${workspaceFolder}/dist/*" 163 | ], 164 | "problemMatcher": [] 165 | }, 166 | { 167 | "label": "Python - Twine Upload to PyPI [TEST]", 168 | "type": "process", 169 | "command": "${config:python.pythonPath}", 170 | "args": [ 171 | "-m", 172 | "twine", 173 | "upload", 174 | "--repository", 175 | "pypitest", 176 | "${workspaceFolder}/dist/*" 177 | ], 178 | "problemMatcher": [] 179 | }, 180 | { 181 | "label": "Python - Publish to PyPI", 182 | "dependsOn": [ 183 | "Python - Twine Upload to PyPI", 184 | "Delete Python Distribution Folder" 185 | ], 186 | "dependsOrder": "sequence", 187 | "problemMatcher": [] 188 | }, 189 | { 190 | "label": "Python - Publish to PyPI [TEST]", 191 | "dependsOn": [ 192 | "Python - Twine Upload to PyPI", 193 | "Delete Python Distribution Folder" 194 | ], 195 | "dependsOrder": "sequence", 196 | "problemMatcher": [] 197 | }, 198 | { 199 | "label": "Python - Upgrade pip", 200 | "type": "process", 201 | "command": "${config:python.pythonPath}", 202 | "args": [ 203 | "-m", 204 | "pip", 205 | "install", 206 | "-U", 207 | "pip" 208 | ], 209 | "problemMatcher": [] 210 | }, 211 | { 212 | "label": "Python - Install Dependencies", 213 | "type": "process", 214 | "command": "${config:python.pythonPath}", 215 | "args": [ 216 | "-m", 217 | "pip", 218 | "install", 219 | "-r", 220 | "${workspaceFolder}/requirements.txt" 221 | ], 222 | "dependsOn": [ 223 | "Python - Upgrade pip" 224 | ], 225 | "problemMatcher": [] 226 | }, 227 | { 228 | "label": "Python - Install Custom bpy", 229 | "type": "process", 230 | "command": "${config:python.pythonPath}", 231 | "args": [ 232 | "-m", 233 | "pip", 234 | "install", 235 | "${workspaceFolder}", 236 | "--global-option=\"build_ext\"", 237 | "--global-option=\"--bpy-prebuilt=${input:PrebuiltBinariesDirectory}\"", 238 | "-v" 239 | ], 240 | "dependsOn": [ 241 | "Delete Python Build Folder" 242 | ] 243 | }, 244 | { 245 | "label": "Make Blender Libs Folder", 246 | "type": "shell", 247 | "linux": { 248 | "command": "mkdir", 249 | "args": [ 250 | "-p", 251 | "${workspaceFolder}/Blender/lib" 252 | ] 253 | }, 254 | "osx": { 255 | "command": "mkdir", 256 | "args": [ 257 | "-p", 258 | "${workspaceFolder}/Blender/lib" 259 | ] 260 | }, 261 | "windows": { 262 | "command": "New-Item", 263 | "args": [ 264 | "-ItemType", 265 | "Directory", 266 | "-Force", 267 | "-Path", 268 | "${workspaceFolder}\\Blender\\lib", 269 | "|", 270 | "Out-Null" 271 | ] 272 | }, 273 | "problemMatcher": [] 274 | }, 275 | { 276 | "label": "Make Blender Build Folder", 277 | "type": "shell", 278 | "linux": { 279 | "command": "mkdir", 280 | "args": [ 281 | "-p", 282 | "${workspaceFolder}/Blender/build/linux" 283 | ] 284 | }, 285 | "osx": { 286 | "command": "mkdir", 287 | "args": [ 288 | "-p", 289 | "${workspaceFolder}/Blender/build/darwin" 290 | ] 291 | }, 292 | "windows": { 293 | "command": "New-Item", 294 | "args": [ 295 | "-ItemType", 296 | "Directory", 297 | "-Force", 298 | "-Path", 299 | "${workspaceFolder}\\Blender\\build\\windows", 300 | "|", 301 | "Out-Null" 302 | ] 303 | }, 304 | "problemMatcher": [] 305 | }, 306 | { 307 | "label": "Make OptiX Folder", 308 | "type": "shell", 309 | "linux": { 310 | "command": "mkdir", 311 | "args": [ 312 | "-p", 313 | "${workspaceFolder}/OptiX" 314 | ] 315 | }, 316 | "osx": { 317 | "command": "mkdir", 318 | "args": [ 319 | "-p", 320 | "${workspaceFolder}/OptiX" 321 | ] 322 | }, 323 | "windows": { 324 | "command": "mkdir", 325 | "args": [ 326 | "-p", 327 | "${workspaceFolder}/OptiX" 328 | ] 329 | }, 330 | "problemMatcher": [] 331 | }, 332 | { 333 | "label": "Browser - Get OptiX [Requires Registration]", 334 | "type": "shell", 335 | "linux": { 336 | "command": "open", 337 | "args": [ 338 | "https://developer.nvidia.com/designworks/optix/download" 339 | ] 340 | }, 341 | "osx": { 342 | "command": "open", 343 | "args": [ 344 | "https://developer.nvidia.com/designworks/optix/download" 345 | ] 346 | }, 347 | "windows": { 348 | "command": "start", 349 | "args": [ 350 | "https://developer.nvidia.com/designworks/optix/download" 351 | ] 352 | }, 353 | "dependsOn": [ 354 | "Make OptiX Folder" 355 | ], 356 | "problemMatcher": [] 357 | }, 358 | { 359 | "label": "Git - Initialize Submodules", 360 | "type": "process", 361 | "command": "git", 362 | "args": [ 363 | "submodule", 364 | "update", 365 | "--init", 366 | "--recursive" 367 | ], 368 | "dependsOn": [ 369 | "Make Blender Libs Folder" 370 | ], 371 | "problemMatcher": [] 372 | }, 373 | { 374 | "label": "Git - Fetch Blender Commits", 375 | "type": "process", 376 | "command": "git", 377 | "args": [ 378 | "fetch" 379 | ], 380 | "options": { 381 | "cwd": "${workspaceFolder}/Blender/blender" 382 | }, 383 | "problemMatcher": [] 384 | }, 385 | { 386 | "label": "Git - Merge Blender Commits", 387 | "type": "process", 388 | "command": "git", 389 | "args": [ 390 | "merge" 391 | ], 392 | "options": { 393 | "cwd": "${workspaceFolder}/Blender/blender" 394 | }, 395 | "problemMatcher": [] 396 | }, 397 | { 398 | "label": "Git - Checkout Blender Tag", 399 | "type": "process", 400 | "command": "git", 401 | "args": [ 402 | "checkout", 403 | "tags/${input:BfGitTag}", 404 | "-b", 405 | "origin/master" 406 | ], 407 | "options": { 408 | "cwd": "${workspaceFolder}/Blender/blender" 409 | }, 410 | "dependsOn": [ 411 | "Git - Fetch Blender Commits" 412 | ], 413 | "problemMatcher": [] 414 | }, 415 | { 416 | "label": "Git - Checkout Blender Master", 417 | "type": "process", 418 | "command": "git", 419 | "args": [ 420 | "checkout", 421 | "master" 422 | ], 423 | "options": { 424 | "cwd": "${workspaceFolder}/Blender/blender" 425 | }, 426 | "dependsOn": [ 427 | "Git - Fetch Blender Commits" 428 | ], 429 | "problemMatcher": [] 430 | }, 431 | { 432 | "label": "Git - Switch To Blender Master [Checkout & Pull]", 433 | "dependsOn": [ 434 | "Git - Checkout Blender Master", 435 | "Git - Merge Blender Commits" 436 | ], 437 | "dependsOrder": "sequence", 438 | "problemMatcher": [] 439 | }, 440 | { 441 | "label": "Update Blender Sources [Checks out master branch]", 442 | "type": "shell", 443 | "command": "./make", 444 | "args": [ 445 | "update" 446 | ], 447 | "options": { 448 | "cwd": "${workspaceFolder}/Blender/blender" 449 | }, 450 | "dependsOn": [ 451 | "Git - Checkout Blender Master" 452 | ], 453 | "problemMatcher": [] 454 | }, 455 | { 456 | "label": "SVN - Checkout Blender Precompiled Libs Trunk", 457 | "type": "process", 458 | "command": "svn", 459 | "linux": { 460 | "args": [ 461 | "checkout", 462 | "https://svn.blender.org/svnroot/bf-blender/trunk/lib/linux_centos7_x86_64/" 463 | ] 464 | }, 465 | "osx": { 466 | "args": [ 467 | "checkout", 468 | "https://svn.blender.org/svnroot/bf-blender/trunk/lib/darwin/" 469 | ] 470 | }, 471 | "windows": { 472 | "args": [ 473 | "checkout", 474 | "https://svn.blender.org/svnroot/bf-blender/trunk/lib/${input:BfSvnTrunkNTPlatform}" 475 | ] 476 | }, 477 | "options": { 478 | "cwd": "${workspaceFolder}/Blender/lib" 479 | }, 480 | "dependsOn": [ 481 | "Make Blender Libs Folder" 482 | ], 483 | "problemMatcher": [] 484 | }, 485 | { 486 | "label": "SVN - Checkout Blender Precompiled Libs Tag", 487 | "type": "process", 488 | "command": "svn", 489 | "linux": { 490 | "args": [ 491 | "checkout", 492 | "https://svn.blender.org/svnroot/bf-blender/tags/${input:BfSvnTag}lib/linux_centos7_x86_64/" 493 | ] 494 | }, 495 | "osx": { 496 | "args": [ 497 | "checkout", 498 | "https://svn.blender.org/svnroot/bf-blender/tags/${input:BfSvnTag}lib/darwin/" 499 | ] 500 | }, 501 | "windows": { 502 | "args": [ 503 | "checkout", 504 | "https://svn.blender.org/svnroot/bf-blender/tags/${input:BfSvnTag}lib/${input:BfSvnTagNTPlatform}" 505 | ] 506 | }, 507 | "options": { 508 | "cwd": "${workspaceFolder}/Blender/lib" 509 | }, 510 | "dependsOn": [ 511 | "Make Blender Libs Folder" 512 | ], 513 | "problemMatcher": [] 514 | }, 515 | { 516 | "label": "First Time - Git & SVN Checkout", 517 | "dependsOn": [ 518 | "Git - Initialize Submodules", 519 | "Update Blender Sources [Checks out master branch]" 520 | ], 521 | "dependsOrder": "sequence", 522 | "problemMatcher": [] 523 | }, 524 | { 525 | "label": "Configure", 526 | "type": "shell", 527 | "linux": { 528 | "command": "cmake ${workspaceFolder}/Blender/blender -DWITH_PYTHON_INSTALL=OFF -DWITH_PYTHON_MODULE=ON -DWITH_CYCLES_CUDA_BINARIES=ON -DWITH_CYCLES_DEVICE_OPTIX=ON -DOPTIX_ROOT_DIR=/NVIDIA-OptiX-SDK-7.1.0-linux64-x86_64", 529 | "options": { 530 | "cwd": "${workspaceFolder}/Blender/build/linux" 531 | } 532 | }, 533 | "osx": { 534 | "command": "cmake ${workspaceFolder}/Blender/blender -DWITH_OPENMP=OFF -DWITH_PYTHON_INSTALL=OFF -DWITH_PYTHON_MODULE=ON", 535 | "options": { 536 | "cwd": "${workspaceFolder}/Blender/build/darwin" 537 | } 538 | }, 539 | "windows": { 540 | "command": "cmake ${workspaceFolder}\\Blender\\blender -DWITH_PYTHON_INSTALL=OFF -DWITH_PYTHON_MODULE=ON -DWITH_CYCLES_CUDA_BINARIES=ON -DWITH_CYCLES_DEVICE_OPTIX=ON -DWITH_WINDOWS_BUNDLE_CRT=OFF", 541 | "options": { 542 | "cwd": "${workspaceFolder}\\Blender\\build\\windows" 543 | } 544 | }, 545 | "dependsOn": [ 546 | "Make Blender Build Folder" 547 | ], 548 | "problemMatcher": [] 549 | }, 550 | { 551 | "label": "Build", 552 | "type": "shell", 553 | "linux": { 554 | "command": "./make", 555 | "args": [ 556 | "-j$((`nproc`+1))", 557 | "install" 558 | ], 559 | "options": { 560 | "cwd": "${workspaceFolder}/Blender/build/linux" 561 | } 562 | }, 563 | "osx": { 564 | "command": "./make", 565 | "args": [ 566 | "-j$((`nproc`+1))", 567 | "install" 568 | ], 569 | "options": { 570 | "cwd": "${workspaceFolder}/Blender/build/darwin" 571 | } 572 | }, 573 | "windows": { 574 | "command": "cmake", 575 | "args": [ 576 | "--build", 577 | ".", 578 | "--target", 579 | "INSTALL", 580 | "--config", 581 | "Release" 582 | ], 583 | "options": { 584 | "cwd": "${workspaceFolder}\\Blender\\build\\windows" 585 | } 586 | }, 587 | "dependsOn": [ 588 | "Configure" 589 | ], 590 | "problemMatcher": [], 591 | "group": { 592 | "kind": "build", 593 | "isDefault": true 594 | } 595 | }, 596 | { 597 | "label": "Build Manylinux Wheels [Requires Docker]", 598 | "type": "shell", 599 | "command": "docker-compose", 600 | "args": [ 601 | "up", 602 | "--build", 603 | "blenderpy-manylinux-wheel-builder" 604 | ], 605 | "problemMatcher": [] 606 | }, 607 | { 608 | "label": "Docker - Full Clean", 609 | "type": "process", 610 | "command": "docker", 611 | "args": [ 612 | "system", 613 | "prune", 614 | "--all", 615 | "--force", 616 | "--volumes" 617 | ], 618 | "problemMatcher": [] 619 | }, 620 | { 621 | "label": "Docker - Create Manylinux Wheel Build Environment", 622 | "type": "process", 623 | "command": "docker", 624 | "args": [ 625 | "build", 626 | "--target", 627 | "blenderpy-manylinux-wheel-builder", 628 | "-t", 629 | "blenderpy/manylinux-wheel-builder", 630 | "-f", 631 | "${workspaceFolder}/.containers/Dockerfile", 632 | "." 633 | ], 634 | "problemMatcher": [] 635 | }, 636 | { 637 | "label": "Docker - Create Windows Wheel Build Environment", 638 | "type": "process", 639 | "command": "docker", 640 | "args": [ 641 | "build", 642 | "--target", 643 | "blenderpy-windows-wheel-builder", 644 | "-t", 645 | "blenderpy/windows-wheel-builder", 646 | "-f", 647 | "${workspaceFolder}/.containers/Dockerfile", 648 | "." 649 | ], 650 | "problemMatcher": [] 651 | }, 652 | { 653 | "label": "Docker - Delete All Containers & Volumes", 654 | "type": "shell", 655 | "command": "docker rm -vf $(docker ps -a -q)", 656 | "problemMatcher": [] 657 | }, 658 | { 659 | "label": "Docker - Delete All Images", 660 | "type": "shell", 661 | "command": "docker rmi -f $(docker images -a -q)", 662 | "problemMatcher": [] 663 | }, 664 | { 665 | "label": "Docker - Delete EVERYTHING", 666 | "type": "shell", 667 | "dependsOn": [ 668 | "Docker - Delete All Containers & Volumes", 669 | "Docker - Delete All Images" 670 | ], 671 | "dependsOrder": "sequence", 672 | "problemMatcher": [] 673 | } 674 | ], 675 | "inputs": [ 676 | { 677 | "id": "BfGitTag", 678 | "type": "command", 679 | "command": "shellCommand.execute", 680 | "args": { 681 | "command": "cd Blender/blender && git tag" 682 | } 683 | }, 684 | { 685 | "id": "BfSvnTag", 686 | "type": "command", 687 | "command": "shellCommand.execute", 688 | "args": { 689 | "command": "svn ls https://svn.blender.org/svnroot/bf-blender/tags/" 690 | } 691 | }, 692 | { 693 | "id": "BfSvnTrunkNTPlatform", 694 | "type": "command", 695 | "command": "shellCommand.execute", 696 | "args": { 697 | "command": "svn ls https://svn.blender.org/svnroot/bf-blender/trunk/lib/ | findstr \"^win\"" 698 | } 699 | }, 700 | { 701 | "id": "BfSvnTagNTPlatform", 702 | "type": "command", 703 | "command": "shellCommand.execute", 704 | "args": { 705 | "command": "svn ls https://svn.blender.org/svnroot/bf-blender/tags/${input:BfSvnTag}lib/ | findstr \"^win\"" 706 | } 707 | }, 708 | { 709 | 710 | "id": "PrebuiltBinariesDirectory", 711 | "type": "promptString", 712 | "description": "The location of the built blender binaries" 713 | } 714 | ] 715 | } -------------------------------------------------------------------------------- /.vscode/tasks/Docker/manylinux/build.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | mkdir -p /Blender/lib 3 | mkdir -p /Blender/build/linux 4 | cd /Blender/build/linux 5 | cmake ${1:-/Blender/blender} -DWITH_PYTHON_INSTALL=OFF -DWITH_PYTHON_MODULE=ON -DWITH_MEM_JEMALLOC=OFF -DWITH_CYCLES_CUDA_BINARIES=ON -DWITH_CYCLES_DEVICE_OPTIX=ON -DOPTIX_ROOT_DIR=/NVIDIA-OptiX-SDK-7.1.0-linux64-x86_64 6 | make -j$((`nproc`+1)) install -------------------------------------------------------------------------------- /.vscode/tasks/Docker/manylinux/build_wheels.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/bash 2 | set -e -u -x 3 | 4 | function repair_wheel { 5 | wheel="$1" 6 | if ! auditwheel show "$wheel"; then 7 | echo "Skipping non-platform wheel $wheel" 8 | else 9 | auditwheel repair "$wheel" --plat manylinux2014_x86_64 -w /blenderpy/wheelhouse/ 10 | fi 11 | } 12 | 13 | # Compile wheels 14 | for PYBIN in /opt/python/cp37*/bin; do 15 | # to install, uncomment the below line 16 | # "${PYBIN}/pip" install /blenderpy --global-option="build_ext" --global-option="--bpy-prebuilt=/build/linux/bin/" -v 17 | "${PYBIN}/pip" wheel /blenderpy --build-option="--bpy-prebuilt=/Blender/build/linux/bin/" --no-deps -v -w wheelhouse/ 18 | done 19 | 20 | # Bundle external shared libraries into the wheels 21 | for whl in wheelhouse/*.whl; do 22 | repair_wheel "$whl" 23 | rm "$whl" 24 | done 25 | 26 | for whl in /blenderpy/wheelhouse/*.whl; do 27 | cp "$whl" /blenderpy/dist/ 28 | done -------------------------------------------------------------------------------- /.vscode/tasks/Docker/manylinux/update_python_requirements.sh: -------------------------------------------------------------------------------- 1 | for PYBIN in /opt/python/cp37*/bin; do 2 | "${PYBIN}/pip" install -U pip 3 | "${PYBIN}/pip" install -r /blenderpy/requirements.txt 4 | done -------------------------------------------------------------------------------- /.vscode/tasks/Docker/windows/build.sh: -------------------------------------------------------------------------------- 1 | cd /Blender/build/windows 2 | cmake ${1:-/Blender/blender} -DWITH_PYTHON_INSTALL=OFF -DWITH_PYTHON_MODULE=ON -DWITH_MEM_JEMALLOC=OFF -DWITH_CYCLES_CUDA_BINARIES=ON -DWITH_CYCLES_DEVICE_OPTIX=ON -DOPTIX_ROOT_DIR=/NVIDIA-OptiX-SDK-7.1.0-linux64-x86_64 3 | make -j$((`nproc`+1)) install -------------------------------------------------------------------------------- /.vscode/tasks/Docker/windows/build_wheels.sh: -------------------------------------------------------------------------------- 1 | py /blenderpy/setup.py sdist bdist_wheel 2 | cp dist/*.whl /dist -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at gubalatyler@gmail.com. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | 75 | For answers to common questions about this code of conduct, see 76 | https://www.contributor-covenant.org/faq 77 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Welcome 2 | Thank you for visiting the `blenderpy` repository, and viewing the contribution guidelines. 3 | 4 | # Getting Started 5 | 6 | Much of the Blender as a Python module build orchestration is provided by VS Code tasks. Some extensions are required to run some of the tasks. Please see the prerequisites. 7 | 8 | ## Prerequisites 9 | 10 | 1. [Visual Studio Code](https://code.visualstudio.com/) 11 | 1. [VS Code Python Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) 12 | 2. [VS Code Tasks Shell Input](https://marketplace.visualstudio.com/items?itemName=augustocdias.tasks-shell-input) 13 | 2. [Docker](https://www.docker.com/) 14 | 3. [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) - (If on Windows) For faster Docker builds, otherwise Docker produces a warning 15 | 4. [Blender build requirements](https://wiki.blender.org/wiki/Building_Blender) - See your operating system's requirements here 16 | 17 | To see how to build, head over to [the wiki](https://github.com/TylerGubala/blenderpy/wiki). 18 | 19 | # Submit a bug report 20 | 21 | If you find something that may be wrong with the code, please feel free to submit a bug report. Try and follow the guidelines outlined [here](https://github.com/TylerGubala/blenderpy/blob/master/.github/ISSUE_TEMPLATE/bug_report.md). I will get back with you. 22 | 23 | # Submit a feature request 24 | 25 | If you want some additional feature added to the repo, please try to follow the guidelines [here](https://github.com/TylerGubala/blenderpy/blob/master/.github/ISSUE_TEMPLATE/feature_request.md), similarly to the bug report, I am open to discussions, so don't hesitate to ask! Additionally, if you want to be a little more informal and discuss it prior, you can always join me in the [Discord](https://discord.gg/d5qqhzK) 26 | 27 | # Create a Pull Request 28 | 29 | Please when implimenting the pull request be sure to update the `setup.py` with any `install_requires` fields that may be necessary per your change. Describe in detail what the improvement is and we can talk about it. 30 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md 2 | include LICENSE -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # blenderpy 2 | Blender as a python module with easy-install 3 | 4 | # Obsoleted 5 | This is no longer the way to install the `bpy` module. Blender Foundation is taking over official support! 6 | 7 | Please see: 8 | 9 | 10 | https://developer.blender.org/T100913 11 | https://github.com/pypa/pypi-support/issues/2231 12 | -------------------------------------------------------------------------------- /blenderpy/__init__.py: -------------------------------------------------------------------------------- 1 | #! /usr/bin/python 2 | # -*- coding: utf-8 3 | """Installation / uninstallation helper scripts 4 | """ 5 | 6 | import os 7 | import pathlib 8 | import platform 9 | import re 10 | import sys 11 | import typing 12 | from typing import Optional 13 | 14 | # Monkey-patch 3.4 and below 15 | 16 | if sys.version_info < (3,5): 17 | 18 | def home_path() -> pathlib.Path: 19 | 20 | return pathlib.Path(os.path.expanduser("~")) 21 | 22 | pathlib.Path.home = home_path 23 | 24 | BLENDER_SCRIPTS_DIR_PATTERN = r"\d\.\d\d" 25 | BLENDER_SCRIPTS_DIR_REGEX = re.compile(BLENDER_SCRIPTS_DIR_PATTERN) 26 | 27 | EXECUTABLE_DIR = pathlib.Path(sys.executable).parent 28 | 29 | BLENDER_SCRIPTS_INSTALL_DIR_LINUX = os.path.join(str(EXECUTABLE_DIR.parent.absolute()), 30 | "lib", "python"+str(sys.version_info[0])+"."+str(sys.version_info[1]), 31 | "site-packages") 32 | BLENDER_SCRIPTS_INSTALL_DIR_MACOS = os.path.join(str(EXECUTABLE_DIR.parent.absolute()), 33 | "lib", "python"+str(sys.version_info[0])+"."+str(sys.version_info[1]), 34 | "Resources") 35 | BLENDER_SCRIPTS_INSTALL_DIR_WINDOWS = str(EXECUTABLE_DIR.absolute()) 36 | 37 | PYTHON_SCRIPTS_DIR_WINDOWS_SYSPYTHON = str(EXECUTABLE_DIR.parent.absolute()) 38 | PYTHON_SCRIPTS_DIR_WINDOWS_VENPYTHON = str(EXECUTABLE_DIR.parent.parent.absolute()) 39 | PYTHON_SCRIPTS_DIR_UNIX = str(EXECUTABLE_DIR.parent.parent.absolute()) 40 | 41 | SYSTEM_NAME = platform.system() 42 | 43 | def find_blender_scripts_directory(search_root: str) -> Optional[str]: 44 | 45 | for _dir, _dirs, _files in os.walk(search_root, followlinks=True): 46 | 47 | if re.match(BLENDER_SCRIPTS_DIR_REGEX, os.path.basename(_dir)) and\ 48 | all([entry in _dirs for entry in ["datafiles", "scripts"]]): 49 | 50 | return _dir 51 | 52 | return None 53 | 54 | def get_python_scripts_directory() -> str: 55 | if SYSTEM_NAME in ["Darwin", "Linux"]: 56 | 57 | return PYTHON_SCRIPTS_DIR_UNIX 58 | 59 | elif SYSTEM_NAME == "Windows": 60 | 61 | if os.path.basename(str(EXECUTABLE_DIR)).casefold() \ 62 | == "scripts".casefold(): 63 | 64 | # User is in venv (probably) 65 | 66 | return PYTHON_SCRIPTS_DIR_WINDOWS_VENPYTHON 67 | 68 | else: 69 | 70 | # User is in system python (probably) 71 | 72 | return PYTHON_SCRIPTS_DIR_WINDOWS_SYSPYTHON 73 | 74 | else: 75 | 76 | raise Exception("Cannot determine system type: "+SYSTEM_NAME) 77 | 78 | def get_blender_scripts_install_dir() -> str: 79 | if SYSTEM_NAME == "Darwin": 80 | 81 | return BLENDER_SCRIPTS_INSTALL_DIR_MACOS 82 | 83 | elif SYSTEM_NAME == "Linux": 84 | 85 | return BLENDER_SCRIPTS_INSTALL_DIR_LINUX 86 | 87 | elif SYSTEM_NAME == "Windows": 88 | 89 | return BLENDER_SCRIPTS_INSTALL_DIR_WINDOWS 90 | 91 | else: 92 | 93 | raise Exception("Cannot determine system type: "+SYSTEM_NAME) -------------------------------------------------------------------------------- /blenderpy/post_install.py: -------------------------------------------------------------------------------- 1 | #! /usr/bin/python 2 | # -*- coding: utf-8 3 | """Post install script 4 | """ 5 | 6 | import os 7 | import pathlib 8 | import shutil 9 | 10 | # Relative imports 11 | from blenderpy import find_blender_scripts_directory,\ 12 | get_blender_scripts_install_dir,\ 13 | get_python_scripts_directory 14 | 15 | def install_scripts_directory(): 16 | 17 | blender_scripts_search_root_dir = get_python_scripts_directory() 18 | blender_scripts_install_dir = get_blender_scripts_install_dir() 19 | 20 | blender_scripts_current_dir = find_blender_scripts_directory(blender_scripts_search_root_dir) 21 | 22 | if blender_scripts_current_dir is not None: 23 | 24 | print("Found Blender scripts directory at " + blender_scripts_current_dir) 25 | 26 | if str(pathlib.Path(blender_scripts_current_dir).parent.absolute()).casefold() == blender_scripts_install_dir.casefold(): 27 | 28 | print(blender_scripts_current_dir+" already direct child of "+blender_scripts_install_dir) 29 | 30 | else: 31 | 32 | print("Moving "+blender_scripts_current_dir+" to "+blender_scripts_install_dir) 33 | 34 | shutil.move(blender_scripts_current_dir, 35 | os.path.join(blender_scripts_install_dir, 36 | os.path.basename(blender_scripts_current_dir))) 37 | 38 | else: 39 | 40 | raise Exception("Could not find Blender scripts directory in " 41 | +blender_scripts_search_root_dir) 42 | 43 | def post_install(): 44 | 45 | install_scripts_directory() 46 | print("Configuration complete, enjoy using Blender as a Python module!") 47 | -------------------------------------------------------------------------------- /blenderpy/pre_uninstall.py: -------------------------------------------------------------------------------- 1 | #! /usr/bin/python 2 | # -*- coding: utf-8 3 | """Pre uninstall script 4 | """ 5 | import shutil 6 | 7 | from blenderpy import find_blender_scripts_directory,\ 8 | get_blender_scripts_install_dir,\ 9 | get_python_scripts_directory 10 | 11 | def remove_blender_scripts_dir(): 12 | """Find and remove the blender scripts directory 13 | """ 14 | 15 | blender_scripts_search_root_dir = get_blender_scripts_install_dir() 16 | 17 | blender_scripts_current_dir = find_blender_scripts_directory(blender_scripts_search_root_dir) 18 | 19 | if blender_scripts_current_dir is not None: 20 | 21 | print("Found blender scripts dir at "+blender_scripts_current_dir) 22 | print("Removing "+blender_scripts_current_dir) 23 | 24 | shutil.rmtree(blender_scripts_current_dir) 25 | 26 | else: 27 | 28 | print("Did not find Blender scripts at post_install script location") 29 | print("Did you forget to perform bpy_post_install after installing?") 30 | print("Searching original pip install location") 31 | 32 | blender_scripts_search_root_dir = get_python_scripts_directory() 33 | 34 | blender_scripts_current_dir = find_blender_scripts_directory(blender_scripts_search_root_dir) 35 | 36 | if blender_scripts_current_dir is not None: 37 | 38 | print("Found blender scripts dir at "+blender_scripts_current_dir) 39 | print("Removing "+blender_scripts_current_dir) 40 | 41 | shutil.rmtree(blender_scripts_current_dir) 42 | 43 | else: 44 | 45 | raise Exception("Could not find Blender scripts directory in " 46 | +blender_scripts_search_root_dir) 47 | 48 | def pre_uninstall(): 49 | print("Searching for and removing non-tracked files & folders") 50 | remove_blender_scripts_dir() 51 | print("Pre uninstall is complete") -------------------------------------------------------------------------------- /docker-compose.yaml: -------------------------------------------------------------------------------- 1 | version: "3.8" 2 | services: 3 | blenderpy-manylinux-wheel-builder: 4 | build: 5 | context: . 6 | dockerfile: ./.containers/Dockerfile 7 | target: blenderpy-manylinux-wheel-builder 8 | command: bash -c "/blenderpy/.vscode/tasks/Docker/manylinux/build.sh && /blenderpy/.vscode/tasks/Docker/manylinux/build_wheels.sh" 9 | container_name: blenderpy-manylinux-wheel-builder 10 | volumes: 11 | - ./Blender/build:/build 12 | - ./Blender:/Blender:delegated 13 | - ./dist:/blenderpy/dist:delegated 14 | blenderpy-windows-wheel-builder: 15 | build: 16 | context: . 17 | dockerfile: ./.containers/Dockerfile 18 | target: blenderpy-windows-wheel-builder 19 | command: bash -c "/blenderpy/.vscode/tasks/Docker/windows/build.sh && /blenderpy/.vscode/tasks/Docker/windows/build_wheels.sh" 20 | container_name: blenderpy-windows-wheel-builder 21 | volumes: 22 | - ./Blender/build:/build 23 | - ./Blender:/Blender:delegated 24 | - ./dist:/blenderpy/dist:delegated -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | astroid==2.4.0 2 | bleach==3.1.5 3 | bpy-build==1.6.2 4 | certifi==2020.4.5.1 5 | chardet==3.0.4 6 | cmake==3.17.2 7 | cmake-generators==1.0.8 8 | colorama==0.4.3 9 | docutils==0.16 10 | future-fstrings==1.2.0 11 | gitdb==4.0.4 12 | GitPython==3.1.11 13 | idna==2.9 14 | importlib-metadata==1.6.0 15 | isort==4.3.21 16 | keyring==21.2.1 17 | lazy-object-proxy==1.4.3 18 | mccabe==0.6.1 19 | nose==1.3.7 20 | packaging==20.3 21 | pkginfo==1.5.0.1 22 | Pygments==2.6.1 23 | pylint==2.5.0 24 | pyparsing==2.4.7 25 | python-dateutil==2.8.1 26 | pywin32-ctypes==0.2.0 27 | readme-renderer==26.0 28 | requests==2.23.0 29 | requests-toolbelt==0.9.1 30 | rope==0.16.0 31 | six==1.14.0 32 | scikit-build 33 | smmap==3.0.2 34 | svn==1.0.1 35 | toml==0.10.0 36 | tqdm==4.45.0 37 | twine==3.1.1 38 | typed-ast==1.4.1 39 | urllib3==1.26.5 40 | webencodings==0.5.1 41 | wrapt==1.12.1 42 | zipp==3.1.0 43 | wheel==0.34.2 -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #! /usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | """ 4 | Build blender into a python module 5 | """ 6 | 7 | from distutils.command.install_data import install_data 8 | import os 9 | import pathlib 10 | import pkg_resources 11 | import platform 12 | import re 13 | from setuptools import find_packages, setup, Extension 14 | from setuptools.command.build_ext import build_ext 15 | from setuptools.command.install import install 16 | from setuptools.command.install_lib import install_lib 17 | from setuptools.command.install_scripts import install_scripts 18 | import shutil 19 | import struct 20 | import sys 21 | from typing import List, Set 22 | from wheel.bdist_wheel import bdist_wheel 23 | 24 | # Monkey-patch 3.4 and below 25 | 26 | if sys.version_info < (3,5): 27 | 28 | def home_path() -> pathlib.Path: 29 | 30 | return pathlib.Path(os.path.expanduser("~")) 31 | 32 | pathlib.Path.home = home_path 33 | 34 | PYTHON_EXE_DIR = os.path.dirname(sys.executable) 35 | 36 | SYSTEM_OS_NAME = platform.system() 37 | 38 | # Change the Blender desired API version variable to build different versions 39 | # of the Blender API. For instance, 'v2.79b' is the same version of the API 40 | # as you would get when opening the Blender application at v2.79b 41 | VERSION = "3.20" 42 | VERSION_TUPLE = pkg_resources.parse_version(VERSION) 43 | 44 | class CMakeExtension(Extension): 45 | """ 46 | An extension to run the cmake build 47 | """ 48 | 49 | def __init__(self, name, sources=[]): 50 | 51 | super().__init__(name = name, sources = sources) 52 | 53 | class InstallCMakeLibsData(install_data): 54 | """ 55 | Just a wrapper to get the install data into the egg-info 56 | """ 57 | 58 | def run(self): 59 | """ 60 | Outfiles are the libraries that were built using cmake 61 | """ 62 | 63 | # There seems to be no other way to do this; I tried listing the 64 | # libraries during the execution of the InstallCMakeLibs.run() but 65 | # setuptools never tracked them, seems like setuptools wants to 66 | # track the libraries through package data more than anything... 67 | # help would be appriciated 68 | 69 | self.outfiles = self.distribution.data_files 70 | 71 | class InstallCMakeLibs(install_lib): 72 | """ 73 | Get the libraries from the parent distribution, use those as the outfiles 74 | 75 | Skip building anything; everything is already built, forward libraries to 76 | the installation step 77 | """ 78 | 79 | def run(self): 80 | """ 81 | Copy libraries from the bin directory and place them as appropriate 82 | """ 83 | 84 | self.announce("Moving library files", level=3) 85 | 86 | # We have already built the libraries in the previous build_ext step 87 | 88 | self.skip_build = True 89 | 90 | bin_dir = self.distribution.bin_dir 91 | 92 | libs = [os.path.join(bin_dir, _lib) for _lib in 93 | os.listdir(bin_dir) if 94 | os.path.isfile(os.path.join(bin_dir, _lib)) and 95 | os.path.splitext(_lib)[1] in [".dll", ".so"] 96 | and not (_lib.startswith("python") or _lib.startswith("bpy"))] 97 | 98 | for lib in libs: 99 | 100 | shutil.move(lib, os.path.join(self.build_dir, 101 | os.path.basename(lib))) 102 | 103 | # Mark the libs for installation, adding them to 104 | # distribution.data_files seems to ensure that setuptools' record 105 | # writer appends them to installed-files.txt in the package's egg-info 106 | # 107 | # Also tried adding the libraries to the distribution.libraries list, 108 | # but that never seemed to add them to the installed-files.txt in the 109 | # egg-info, and the online recommendation seems to be adding libraries 110 | # into eager_resources in the call to setup(), which I think puts them 111 | # in data_files anyways. 112 | # 113 | # What is the best way? 114 | 115 | self.distribution.data_files = [os.path.join(self.install_dir, 116 | os.path.basename(lib)) 117 | for lib in libs] 118 | 119 | # Must be forced to run after adding the libs to data_files 120 | 121 | self.distribution.run_command("install_data") 122 | 123 | super().run() 124 | 125 | class InstallBlenderScripts(install_scripts): 126 | """ 127 | Install the scripts available from the "version folder" in the build dir 128 | """ 129 | 130 | def run(self): 131 | """ 132 | Copy the required directory to the build directory and super().run() 133 | """ 134 | 135 | self.announce("Moving scripts files", level=3) 136 | 137 | self.skip_build = True 138 | 139 | bin_dir = self.distribution.bin_dir 140 | 141 | scripts_dirs = [os.path.join(bin_dir, _dir) for _dir in 142 | os.listdir(bin_dir) if 143 | os.path.isdir(os.path.join(bin_dir, _dir))] 144 | 145 | for scripts_dir in scripts_dirs: 146 | 147 | dst_dir = os.path.join(self.build_dir, 148 | os.path.basename(scripts_dir)) 149 | 150 | # Mostly in case of weird things happening during build 151 | if os.path.exists(dst_dir): 152 | 153 | if os.path.isdir(dst_dir): 154 | 155 | shutil.rmtree(dst_dir) 156 | 157 | elif os.path.isfile(dst_dir): 158 | 159 | os.remove(dst_dir) 160 | 161 | # Copy the blender scripts directory 162 | 163 | shutil.copytree(scripts_dir, 164 | os.path.join(self.build_dir, 165 | os.path.basename(scripts_dir))) 166 | 167 | # Mark the scripts for installation, adding them to 168 | # distribution.scripts seems to ensure that the setuptools' record 169 | # writer appends them to installed-files.txt in the package's egg-info 170 | 171 | self.distribution.scripts = scripts_dirs 172 | 173 | super().run() 174 | 175 | class CMakeBuild(bdist_wheel): 176 | """Create custom build 177 | """ 178 | 179 | user_options = bdist_wheel.user_options + [ 180 | ("bpy-prebuilt=", None, "Location of prebuilt bpy binaries"), 181 | ("bpy-cmake-configure-args=", None, "Custom CMake options") 182 | ] 183 | 184 | def initialize_options(self): 185 | """Allows for `cmake_extension_prebuild_dir` 186 | """ 187 | 188 | super().initialize_options() 189 | self.bpy_prebuilt = None 190 | self.bpy_cmake_configure_args = None 191 | 192 | class BuildCMakeExt(build_ext): 193 | """ 194 | Builds using cmake instead of the python setuptools implicit build 195 | """ 196 | user_options = build_ext.user_options + [ 197 | ("bpy-prebuilt=", None, "Location of prebuilt bpy binaries"), 198 | ("bpy-cmake-configure-args=", None, "Custom CMake options") 199 | ] 200 | 201 | def initialize_options(self): 202 | """Allows for `cmake_extension_prebuild_dir` 203 | """ 204 | 205 | super().initialize_options() 206 | self.bpy_prebuilt = None 207 | self.bpy_cmake_configure_args = None 208 | 209 | def finalize_options(self): 210 | """Grab options from previous call to `build` 211 | 212 | This is required to get the options passed into --build-options 213 | during bdist_wheel creation 214 | """ 215 | 216 | super().finalize_options() 217 | 218 | self.set_undefined_options('bdist_wheel', 219 | ('bpy_prebuilt', 'bpy_prebuilt'), 220 | ('bpy_cmake_configure_args', 221 | 'bpy_cmake_configure_args') 222 | ) 223 | 224 | def run(self): 225 | """ 226 | Perform build_cmake before doing the 'normal' stuff 227 | """ 228 | 229 | os.makedirs(str(pathlib.Path(self.build_temp).absolute()), 230 | exist_ok=True) 231 | 232 | for extension in self.extensions: 233 | 234 | extension_path = pathlib.Path(self.get_ext_fullpath(extension.name)) 235 | 236 | if isinstance(extension,CMakeExtension): 237 | 238 | self.announce(f"Preparing the build environment for CMake " 239 | f"extension: \"{extension.name}\"", level=3) 240 | 241 | os.makedirs(str(extension_path.parent.absolute()), 242 | exist_ok=True) 243 | 244 | if extension.name == "bpy": 245 | 246 | if self.bpy_prebuilt: # user assumes responsibility 247 | # for built files 248 | 249 | self.announce(f"Using supplied prebuilt path " 250 | f"{self.bpy_prebuilt}", level=3) 251 | 252 | self.copy_bpy(self.bpy_prebuilt, extension_path) 253 | 254 | else: # we assume responsibility for built files 255 | 256 | git_checkout_path = pathlib.Path(os.path.join(self.build_temp, "blender")) 257 | build_path = pathlib.Path(os.path.join(self.build_temp, "build")) 258 | 259 | os.makedirs(str(git_checkout_path), exist_ok=True) 260 | os.makedirs(str(build_path), exist_ok=True) 261 | 262 | self.build_bpy(git_checkout_path, self.build_temp, build_path) 263 | 264 | super().run() 265 | 266 | def build_bpy(self, git_checkout_path: pathlib.Path, 267 | svn_checkout_path: pathlib.Path, build_path: pathlib.Path): 268 | """ 269 | The steps required to build the extension 270 | """ 271 | # Import bpybuild here because otherwise the script will 272 | # fail before bpybuilt is retrieved 273 | 274 | import bpybuild.sources 275 | import bpybuild.make 276 | 277 | self.announce("Searching for compatible Blender online " 278 | "(this will take a while)", level=3) 279 | 280 | compatible_bpy = bpybuild.sources.get_compatible_sources() 281 | 282 | if not VERSION_TUPLE in compatible_bpy: 283 | 284 | raise Exception(f"{VERSION} bpy is not compatible with " 285 | f"{SYSTEM_OS_NAME} Python {sys.version} " 286 | f"{bpybuild.BITNESS}bit") 287 | 288 | self.announce(f"Found compatible Blender version {VERSION}", level=3) 289 | 290 | git_repo = compatible_bpy[VERSION_TUPLE][0][0] 291 | svn_repo = compatible_bpy[VERSION_TUPLE][1][0] 292 | # When using compatible_sources you always get a git and svn repo object 293 | 294 | self.announce("Cloning Blender source from git " 295 | "(this will take a while)", level=3) 296 | 297 | git_repo.checkout(git_checkout_path) # Clones into 'blender' 298 | 299 | self.announce("Cloning precompiled libs from svn " 300 | "(this will take a while)", level=3) 301 | 302 | svn_repo.checkout(svn_checkout_path) # Checkout into 'lib' (automatic) 303 | 304 | self.announce("Configuring cmake project and building binaries " 305 | "(this will take a while)", level=3) 306 | 307 | for command in bpybuild.make.get_make_commands(source_location= git_checkout_path, 308 | build_location= build_path, 309 | cmake_configure_args = self.cmake_configure_args): 310 | 311 | self.spawn(command) 312 | 313 | # Build finished, now copy the files into the copy directory 314 | # The copy directory is the parent directory of the extension (.pyd) 315 | 316 | def copy_bpy(self, source_path: pathlib.Path, dest_path: pathlib.Path): 317 | """ 318 | Move the bpy files 319 | """ 320 | 321 | self.announce("Searching for Blender python module", level=3) 322 | 323 | bpy_canidates = [os.path.join(source_path, _bpy) for _bpy in 324 | os.listdir(source_path) if 325 | os.path.isfile(os.path.join(source_path, _bpy)) and 326 | os.path.splitext(_bpy)[0].startswith('bpy') and 327 | os.path.splitext(_bpy)[1] in [".pyd", ".so"]] 328 | 329 | if not bpy_canidates: 330 | 331 | raise Exception(f"Could not find Blender python module in {source_path}") 332 | 333 | bpy_path = bpy_canidates[0] 334 | 335 | self.distribution.bin_dir = source_path 336 | 337 | self.announce("Moving Blender python module", level=3) 338 | 339 | shutil.copy(str(bpy_path), str(dest_path)) 340 | 341 | # After build_ext is run, the following commands will run: 342 | # 343 | # install_lib 344 | # install_scripts 345 | # 346 | # These commands are subclassed above to avoid pitfalls that 347 | # setuptools tries to impose when installing these, as it usually 348 | # wants to build those libs and scripts as well or move them to a 349 | # different place. See comments above for additional information 350 | 351 | setup(name='bpy', 352 | version="2.93a0", 353 | packages=find_packages(), 354 | ext_modules=[CMakeExtension(name="bpy")], 355 | entry_points={ 356 | "console_scripts": [ 357 | "bpy_post_install = " 358 | "blenderpy.post_install:post_install", 359 | "bpy_pre_uninstall = " 360 | "blenderpy.pre_uninstall:pre_uninstall" 361 | ] 362 | }, 363 | description='Blender as a python module', 364 | long_description=open(os.path.join(os.path.dirname(os.path.abspath(__file__)),"README.md"), 'r').read(), 365 | long_description_content_type="text/markdown", 366 | keywords="Blender, 3D, Animation, Renderer, Rendering", 367 | classifiers=["Development Status :: 3 - Alpha", 368 | "Environment :: Win32 (MS Windows)", 369 | "Intended Audience :: Developers", 370 | "License :: OSI Approved :: " 371 | "GNU General Public License v3 (GPLv3)", 372 | "Natural Language :: English", 373 | "Operating System :: MacOS", 374 | "Operating System :: POSIX :: Linux", 375 | "Operating System :: Microsoft :: Windows", 376 | "Programming Language :: C", 377 | "Programming Language :: C++", 378 | "Programming Language :: Python :: Implementation :: " 379 | "CPython", 380 | "Topic :: Artistic Software", 381 | "Topic :: Education", 382 | "Topic :: Multimedia", 383 | "Topic :: Multimedia :: Graphics", 384 | "Topic :: Multimedia :: Graphics :: 3D Modeling", 385 | "Topic :: Multimedia :: Graphics :: 3D Rendering", 386 | "Topic :: Games/Entertainment"], 387 | author='Tyler Gubala', 388 | author_email='gubalatyler@gmail.com', 389 | license='GPL-3.0', 390 | python_requires=">=3.7, <3.8", 391 | install_requires=["numpy==1.19.3"], 392 | url="https://github.com/TylerGubala/blenderpy", 393 | cmdclass={ 394 | 'bdist_wheel': CMakeBuild, 395 | 'build_ext': BuildCMakeExt, 396 | 'install_data': InstallCMakeLibsData, 397 | 'install_lib': InstallCMakeLibs, 398 | 'install_scripts': InstallBlenderScripts 399 | }, 400 | setup_requires=[ 401 | "bpy-build", 402 | "wheel" 403 | ] 404 | ) 405 | -------------------------------------------------------------------------------- /tests/test_bpy.py: -------------------------------------------------------------------------------- 1 | import bpy 2 | 3 | assert bpy is not None 4 | assert bpy.types is not None 5 | 6 | import bmesh 7 | 8 | assert bmesh is not None -------------------------------------------------------------------------------- /tests/test_concurrent_futures.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | """A basic example program that shows the `bpy` and `multiprocessing` fix 4 | 5 | Compatibility between these two libraries is strained by `bpy`'s own 6 | requirement to append its user and addon modules directories to the `sys.path` 7 | as well as the presence of a module in the addons directory called `bpy`, 8 | resulting in an ambiguity between the legitimate `bpy` Blender runtime module 9 | and the addon module the Blender 3d application requires 10 | """ 11 | # STD LIB imports 12 | import concurrent.futures 13 | from multiprocessing import freeze_support # For NT python exe creation 14 | import sys 15 | 16 | def multiFunction(data): 17 | import bpy 18 | print(data) 19 | print(bpy) 20 | 21 | if __name__ == '__main__' : 22 | 23 | freeze_support() 24 | 25 | data = ['Uno','Deux','Three'] 26 | 27 | with concurrent.futures.ProcessPoolExecutor() as p: 28 | 29 | p.map(multiFunction,data) 30 | --------------------------------------------------------------------------------