README.en-US.md

cpform

CPForm is a declarative PyQt/PySide UI library designed to simplify PyQt/PySide interface development. It provides a declarative approach to create and manage user interfaces, making code more concise and maintainable.

English | 中文

Table of Contents

• Table of Contents
  • Features
  • Quick Start
    • Installation
    • Testing
  • Usage Guide
    • Native
    • Maya
    • 3ds Max
  • Credits
  • LLM Quick Reference
  • License

Features

1. Support for both Python 2 and Python 3
2. Declarative coding style
3. Simple usage logic
4. Easy integration with PyQt and PySide

Quick Start

Installation

• CPForm is not yet published to PyPI, but you can install it from source code by following these steps:

git clone git@github.com:cpcgskill/cpform.git
cd cpform

• Or download the source code archive directly from GitHub and extract it.

Testing

CPForm provides a simple test script that can be run with the following command:

python3 ./scripts/cpform_test/core.py # python3 may need to be replaced with your own Python path

Usage Guide

Native

Here we use PySide2+Python3 as an example. Other versions of PyQt/PySide have similar usage.

from PySide2.QtWidgets import *
import sys

app = QApplication(sys.argv)

from cpform.widget.core import *
import cpform.docker as docker


def show():
    ui = ScrollArea(
        VBoxLayout(
            childs=[
                Label('Label'),
                PrimaryButton(text='PrimaryButton'),
                AttentionButton(text='AttentionButton'),
                SuccessButton(text='SuccessButton'),
                WarningButton(text='WarningButton'),
                ErrorButton(text='ErrorButton'),
                NormalButton(text='Button'),
            ],
            align='top'
        )
    )
    docker.default_docker(title='Native Example', form=ui)


show()
app.exec_()

Maya

CPForm usage in Maya is similar to Native, but you don't need to create a QApplication instance when launching in Maya. You can run the following code directly in Maya's Python Script Editor:

from cpform.widget.core import *
import cpform.docker as docker


def show():
    ui = ScrollArea(
        VBoxLayout(
            childs=[
                Label('Label'),
                PrimaryButton(text='PrimaryButton'),
                AttentionButton(text='AttentionButton'),
                SuccessButton(text='SuccessButton'),
                WarningButton(text='WarningButton'),
                ErrorButton(text='ErrorButton'),
                NormalButton(text='Button'),
            ],
            align='top'
        )
    )
    docker.default_docker(title='Maya Example', form=ui)


show()

• Note: When using CPForm in Maya, please ensure that the src directory under CPForm has been added to Maya's Python path.
• Alternatively, copy all files under src to Maya's Python scripts directory.

3ds Max

todo, CPForm will automatically handle code compatibility, so usage in 3ds Max is similar to Maya. You just need to make sure to add it to 3ds Max's Python path.

Credits

• Icons source: https://github.com/feathericons/feather

LLM Quick Reference

See the root file llms.txt for a condensed, model-friendly overview including:

• Component & layout inventory
• Data collection (read_data()) semantics
• Theming via config_manager
• Common window / dialog / popup / form submission patterns

Include llms.txt in AI prompt contexts to improve generation accuracy and reduce token overhead.

License

This project is licensed under Apache-2.0. For details, see LICENSE