# pyblish-simple
A Pyblish GUI trying to be more 'intuitive' than [pyblish lite](https://github.com/pyblish/pyblish-lite) & [pyblish-qml](https://github.com/pyblish/pyblish-qml)
## Limitations
⚠️ It was designed for validating instances, and currently doesn't show context, export or publish plugins.
_left pyblish_lite, right pyblish_simple_
## How to use
### Users
- Collected instances show on the left
- Select an instance to show relevant validations in the bottom right
- Select a validation to show it's description in the top right
- right click an instance or plugin to show it's actions in the menu.
colors:
- 🟢 <span style="color: green;">green</span>: the validation passed
- 🟠 <span style="color: orange;">orange</span>: a warning, soft fail, publishing is allowed to continue
- 🔴 <span style="color: red;">red</span>: an error, hard fail, publishing is not allowed to continue
- ⚪ <span style="color: white;">white</span>: validation did not run
- ⚫ <span style="color: grey;">grey</span>: validation is disabled but registered (NOT YET IMPLEMENTED)
### Devs
- to hook up the `fix all` button: Give your plugins the attribute `fix`.
Pyblish simple assumes this is a pyblish action & runs it
```python
# code in pyblish simple
if hasattr(plugin, 'fix'):
pyblish_action = plugin.fix
pyblish_action.process(self=pyblish_action, context=self.context, plugin=plugin)
```
- avoid context plugins, and use instance plugins instead.
## install
- copy paste the pyblish_simple module
- install the dependencies `Qt.py` & optionally `PyQt5_stylesheets`
to launch the UI, run:
```python
import pyblish_simple
pyblish_simple.show()
```
## What's pyblish simple & why was it developed?
The standard UI for Pyblish confused artists:
- it shows which validation failed, but not which instance failed.
e.g. Pyblish flags that a vertex is incorrect, but not which one. The artist is frustrated, because they don't know which vertex to fix.
- it shows a lot of info, overwhelming non-technical users. Artists don't find it intuitive.
To solve this, pyblish-simple shows a list of instances.
When you select an instance, it only shows the valiations that affected that instance.
This UI is much more intuitive for 3D artists.
- it shows only relevant info for each instance, hiding all other validations. Making the UI less overwhelming
- It's more relatable, because a list of instances is something the 3d artist is used to.
e.g. a list of meshes in the scene, a list of materials in the scene, the outliner in 3ds Max, Maya, Unreal, Unity, ...
## development
- [ ] improve the stylesheet. current dark mode doesn't look as nice as pyblish lite
- [ ] selected color overwrites the color, which is bad UX, fix this
- [ ] clean up the code. It's in need of some love, since it was quickly put together.
- [ ] it was designed for validating instances, and currently assumes a standard collect, validate, export, publish workflow.
- [ ] research how to show context plugins
- [ ] research how to show export and publish plugins
PR-s are welcome.
## community
- [Pyblish forum thread](https://forums.pyblish.com/t/pyblish-simple-a-new-ui-aimed-at-artists/701)
- PYPI https://pypi.org/project/pyblish-simple/
Raw data
{
"_id": null,
"home_page": "",
"name": "pyblish-simple",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": "",
"keywords": "plugin,pyblish,add-on,extension,manager,studio,dcc,app,application,artist",
"author": "Hannes",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/7e/e4/b665eeec978e581f9ddafbfd16fa992f076dbf1122609c87569b48da0724/pyblish-simple-0.0.2.tar.gz",
"platform": null,
"description": "# pyblish-simple\nA Pyblish GUI trying to be more 'intuitive' than [pyblish lite](https://github.com/pyblish/pyblish-lite) & [pyblish-qml](https://github.com/pyblish/pyblish-qml)\n\n## Limitations\n\u26a0\ufe0f It was designed for validating instances, and currently doesn't show context, export or publish plugins.\n\n\n_left pyblish_lite, right pyblish_simple_\n\n## How to use\n### Users\n- Collected instances show on the left \n- Select an instance to show relevant validations in the bottom right\n- Select a validation to show it's description in the top right\n- right click an instance or plugin to show it's actions in the menu.\n\ncolors:\n- \ud83d\udfe2 <span style=\"color: green;\">green</span>: the validation passed \n- \ud83d\udfe0 <span style=\"color: orange;\">orange</span>: a warning, soft fail, publishing is allowed to continue\n- \ud83d\udd34 <span style=\"color: red;\">red</span>: an error, hard fail, publishing is not allowed to continue\n- \u26aa <span style=\"color: white;\">white</span>: validation did not run\n- \u26ab <span style=\"color: grey;\">grey</span>: validation is disabled but registered (NOT YET IMPLEMENTED) \n\n### Devs\n- to hook up the `fix all` button: Give your plugins the attribute `fix`. \nPyblish simple assumes this is a pyblish action & runs it\n```python\n# code in pyblish simple\nif hasattr(plugin, 'fix'):\n pyblish_action = plugin.fix\n pyblish_action.process(self=pyblish_action, context=self.context, plugin=plugin)\n```\n- avoid context plugins, and use instance plugins instead.\n\n## install\n- copy paste the pyblish_simple module\n- install the dependencies `Qt.py` & optionally `PyQt5_stylesheets`\n\nto launch the UI, run:\n```python\nimport pyblish_simple\npyblish_simple.show()\n```\n\n\n## What's pyblish simple & why was it developed? \nThe standard UI for Pyblish confused artists:\n- it shows which validation failed, but not which instance failed. \ne.g. Pyblish flags that a vertex is incorrect, but not which one. The artist is frustrated, because they don't know which vertex to fix.\n- it shows a lot of info, overwhelming non-technical users. Artists don't find it intuitive. \n\nTo solve this, pyblish-simple shows a list of instances. \nWhen you select an instance, it only shows the valiations that affected that instance. \nThis UI is much more intuitive for 3D artists.\n- it shows only relevant info for each instance, hiding all other validations. Making the UI less overwhelming\n- It's more relatable, because a list of instances is something the 3d artist is used to. \ne.g. a list of meshes in the scene, a list of materials in the scene, the outliner in 3ds Max, Maya, Unreal, Unity, ...\n\n\n## development\n- [ ] improve the stylesheet. current dark mode doesn't look as nice as pyblish lite\n- [ ] selected color overwrites the color, which is bad UX, fix this\n- [ ] clean up the code. It's in need of some love, since it was quickly put together.\n- [ ] it was designed for validating instances, and currently assumes a standard collect, validate, export, publish workflow.\n - [ ] research how to show context plugins\n - [ ] research how to show export and publish plugins\n\nPR-s are welcome.\n\n## community\n- [Pyblish forum thread](https://forums.pyblish.com/t/pyblish-simple-a-new-ui-aimed-at-artists/701)\n- PYPI https://pypi.org/project/pyblish-simple/\n",
"bugtrack_url": null,
"license": "",
"summary": "a GUI for pyblish, to see which instance failed and why",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/hannesdelbeke/pyblish-simple",
"Source": "https://github.com/hannesdelbeke/pyblish-simple"
},
"split_keywords": [
"plugin",
"pyblish",
"add-on",
"extension",
"manager",
"studio",
"dcc",
"app",
"application",
"artist"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6efaa5c82610afc27a99f58d7cf22ee1470acae0e42d9cbd61efe78c810f68c7",
"md5": "5fdfafc25b07f372e797b707fb454696",
"sha256": "0f64c537c5cd4e9c0c47cf9aa773dc9a4f4e6dcd583aa28c5c57dd9f91b526a1"
},
"downloads": -1,
"filename": "pyblish_simple-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5fdfafc25b07f372e797b707fb454696",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 5951,
"upload_time": "2023-06-26T12:24:12",
"upload_time_iso_8601": "2023-06-26T12:24:12.290763Z",
"url": "https://files.pythonhosted.org/packages/6e/fa/a5c82610afc27a99f58d7cf22ee1470acae0e42d9cbd61efe78c810f68c7/pyblish_simple-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7ee4b665eeec978e581f9ddafbfd16fa992f076dbf1122609c87569b48da0724",
"md5": "90f9cdf2509c5575efded657d4f7326e",
"sha256": "c754f7ca074294ca864c4f4ef6d3de04f225904b94e5da5a08d711a4bfde5503"
},
"downloads": -1,
"filename": "pyblish-simple-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "90f9cdf2509c5575efded657d4f7326e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 131395,
"upload_time": "2023-06-26T12:24:13",
"upload_time_iso_8601": "2023-06-26T12:24:13.931224Z",
"url": "https://files.pythonhosted.org/packages/7e/e4/b665eeec978e581f9ddafbfd16fa992f076dbf1122609c87569b48da0724/pyblish-simple-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-26 12:24:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hannesdelbeke",
"github_project": "pyblish-simple",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pyblish-simple"
}
JSON
