PyVFX Boilerplate 项目教程

PyVFX Boilerplate 项目教程

pyvfx-boilerplate A boilerplate for creating PySide/PyQt or PySide2/PyQt5 applications running inside of Maya, Nuke and standalone - using Python 2 or 3. 项目地址: https://gitcode.com/gh_mirrors/py/pyvfx-boilerplate

1. 项目的目录结构及介绍

PyVFX Boilerplate 项目的目录结构如下：

pyvfx-boilerplate/
├── src/
│   └── pyvfx_boilerplate/
│       ├── __init__.py
│       ├── boilerplate_ui.py
│       └── ...
├── github/
│   └── workflows/
│       └── ...
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── setup.cfg
└── setup.py

目录结构介绍

• src/pyvfx_boilerplate/: 包含项目的主要源代码文件。

  • __init__.py: 初始化文件，用于定义模块。
  • boilerplate_ui.py: 项目的主要用户界面代码。
  • 其他文件：包含项目的其他功能模块。

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。

• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。

• CHANGELOG.md: 记录项目的变更日志。

• LICENSE: 项目的开源许可证文件。

• README.md: 项目的说明文档。

• setup.cfg: 项目的配置文件，用于定义安装和打包的配置。

• setup.py: 项目的安装脚本，用于打包和分发项目。

2. 项目的启动文件介绍

项目的启动文件是 src/pyvfx_boilerplate/boilerplate_ui.py。该文件包含了项目的用户界面逻辑和启动代码。

启动文件介绍

• boilerplate_ui.py:
  • 该文件定义了项目的用户界面类 BoilerplateRunner，并提供了启动方法 run_main()。
  • 通过调用 run_main() 方法，可以启动项目的用户界面。

启动方法

from pyvfx_boilerplate import boilerplate_ui

bpr = boilerplate_ui.BoilerplateRunner()
bpr.run_main()

3. 项目的配置文件介绍

项目的配置文件主要包括 setup.cfg 和 setup.py。

setup.cfg

setup.cfg 文件用于定义项目的安装和打包配置。以下是该文件的主要内容：

[metadata]
name = pyvfx-boilerplate
version = 3.x
description = A boilerplate for creating PySide/PyQt or PySide2/PyQt5 applications running inside of Maya, Nuke and standalone - using Python 2 or 3
author = Fredrik Averpil
license = MIT

[options]
packages = find:
install_requires =
    PyQt5
    PySide2
    Qt.py

setup.py

setup.py 文件是项目的安装脚本，用于打包和分发项目。以下是该文件的主要内容：

from setuptools import setup, find_packages

setup(
    name='pyvfx-boilerplate',
    version='3.x',
    description='A boilerplate for creating PySide/PyQt or PySide2/PyQt5 applications running inside of Maya, Nuke and standalone - using Python 2 or 3',
    author='Fredrik Averpil',
    license='MIT',
    packages=find_packages(),
    install_requires=[
        'PyQt5',
        'PySide2',
        'Qt.py'
    ],
)

配置文件介绍

• setup.cfg:

  • [metadata] 部分定义了项目的元数据，如名称、版本、描述、作者和许可证。
  • [options] 部分定义了项目的安装选项，如需要安装的包和依赖项。

• setup.py:

  • 使用 setuptools 模块来定义项目的安装配置。
  • name、version、description、author 和 license 字段定义了项目的元数据。
  • packages 字段指定了需要包含在安装包中的包。
  • install_requires 字段指定了项目所需的依赖项。

通过这些配置文件，可以方便地安装和分发 PyVFX Boilerplate 项目。

pyvfx-boilerplate A boilerplate for creating PySide/PyQt or PySide2/PyQt5 applications running inside of Maya, Nuke and standalone - using Python 2 or 3. 项目地址: https://gitcode.com/gh_mirrors/py/pyvfx-boilerplate