menuet 1.0.0__tar.gz

menuet-1.0.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.py[oc]
+build/
+dist/
+site/
+wheels/
+*.egg-info
+.coverage*
+.venv/
+.cache/
+.rumdl_cache/

menuet-1.0.0/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+Versions follow [Semantic Versioning](https://semver.org)
+(`<major>.<minor>.<patch>`).
+
+This file is managed by [towncrier](https://towncrier.readthedocs.io),
+and its format is based on [keep a changelog](https://keepachangelog.com).
+
+Changes for the upcoming release can be found in the
+[changelog.d](https://codeberg.org/tahv/menuet/src/branch/main/changelog.d)
+directory in the repo.
+
+<!-- towncrier release notes start -->
+
+## [1.0.0](https://codeberg.org/tahv/menuet/releases/tag/1.0.0) - 2026-04-06
+
+### Enhancements
+
+- [!1](https://codeberg.org/tahv/menuet/pulls/1):
+  Initial release.

menuet-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# Contributing
+
+## Project commands
+
+The easiest way to run project commands is to
+[install just](https://just.systems/man/en/installation.html).
+
+For example, the `rust-just` Python package can be installed with
+[`uv`](https://docs.astral.sh/uv/concepts/tools/):
+
+```console
+uv tool install rust-just
+just
+```
+
+Or executed without installation with
+[`uvx`](https://docs.astral.sh/uv/guides/tools/):
+
+```console
+uvx --from rust-just just
+```
+
+Running `just` without any arguments list available recipes in the
+[justfile](./justfile) at the root of the repo.
+
+```console
+just
+```
+
+## Local development environment
+
+The project virtual environment can be created with `uv`:
+
+```console
+uv sync --all-extras
+```
+
+Or with this `just` recipe:
+
+```console
+just sync
+```
+
+If you don't want to use `uv` or `just`, you can use pip 25.1
+(that added support for dependency groups)
+or newer and install the dependencies manually:
+
+```console
+pip install --editable .[copy,qt] --group dev
+```
+
+## Changelog
+
+We use [towncrier](https://towncrier.readthedocs.io/) to manage our
+[CHANGELOG.md](./CHANGELOG.md).
+
+To create a news fragment,
+run the following command and follow the instructions:
+
+```console
+towncrier create --no-edit
+```
+
+Or use this `just` recipe:
+
+```console
+just news
+```
+
+Alternatively, you don't need to install towncrier,
+you just have to abide by a few simple rules:
+
+For each merge request, add a new file into the `changelog.d` directory with a
+filename adhering to the schema: `mr#.(break|feat|fix|doc|other|chore).md`.
+For example, `changelog.d/123.feat.md` for a feature
+that is proposed in pull request `#123`.
+
+See `tool.towncrier.types` in the [`pyproject.toml`](./pyproject.toml)
+for the list of fragment types.

menuet-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Thibaud Gambier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

menuet-1.0.0/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: menuet
+Version: 1.0.0
+Summary: Declarative menu builder for DCC applications
+Project-URL: Repository, https://codeberg.org/tahv/menuet
+Author: Thibaud Gambier
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: attrs>=26.1.0
+Requires-Dist: tomli>=2.3.0; python_version < '3.11'
+Requires-Dist: typing-extensions>=4.15.0
+Provides-Extra: copy
+Requires-Dist: copykitten>=2.0.0; extra == 'copy'
+Provides-Extra: qt
+Requires-Dist: pyside6>=6.11.0; extra == 'qt'
+Description-Content-Type: text/markdown
+
+# menuet
+
+[![Source](https://img.shields.io/badge/Codeberg-%232185D0?logo=codeberg&logoColor=white)](https://codeberg.org/tahv/menuet)
+[![Documentation](https://img.shields.io/badge/Documentation-teal)](https://tahv.codeberg.page/menuet/)
+
+Menuet (`/mə.nɥɛ/`) is a declarative menu builder for DCC applications.
+
+## Features
+
+- Supports, 3ds Max, Maya, MotionBuilder and other any PySide6 application.
+- Load menu from a TOML or JSON configuration, from a dict, from entry points,
+  or build it programmatically.
+- Declare one or more menus in a dedicated `.toml` file.
+- Compose menu from multiple `.toml` files.
+- Declare a menu in a `pyproject.toml` directly.
+
+## Installation
+
+```console
+pip install menuet
+```
+
+## Usage
+
+Create a menu configuration in [TOML](https://toml.io/) format.
+
+```toml
+# menu.toml
+[[action]]
+id = "print-hello"
+label = "Print Hello"
+cb = "print('Hello')"
+group = "Some Separator"
+
+[[action]]
+id = "open-gui"
+label = "Open GUI"
+cb = "ep:myapp.gui:open_gui"
+menu = ["Foo", "Bar"]
+```
+
+Load the above configuration into a `Model` and pass
+that model to a Menu Builder to create a menu.
+
+```python
+from pathlib import Path
+from menuet.builders.text import Render, TextMenuBuilder
+from menuet.model import Model, loads
+
+model = Model()
+loads(Path("menu.toml").read_text(), model)
+
+builder = TextMenuBuilder(model, root_menu="Demo", render=Render.UTF8)
+print(builder.build())
+```
+
+```text
+Demo
+├── Foo
+│   └── Bar
+│       └── Open GUI
+├── Some Separator ───
+└── Print Hello
+```
+
+See the [documentation](https://tahv.codeberg.page/menuet/)
+for more advanced patterns.
+
+## Contributing
+
+For guidance on setting up a development environment and contributing, see
+[CONTRIBUTING.md](https://codeberg.org/tahv/menuet/src/branch/main/CONTRIBUTING.md).

menuet-1.0.0/README.md

@@ -0,0 +1,72 @@
+# menuet
+
+[![Source](https://img.shields.io/badge/Codeberg-%232185D0?logo=codeberg&logoColor=white)](https://codeberg.org/tahv/menuet)
+[![Documentation](https://img.shields.io/badge/Documentation-teal)](https://tahv.codeberg.page/menuet/)
+
+Menuet (`/mə.nɥɛ/`) is a declarative menu builder for DCC applications.
+
+## Features
+
+- Supports, 3ds Max, Maya, MotionBuilder and other any PySide6 application.
+- Load menu from a TOML or JSON configuration, from a dict, from entry points,
+  or build it programmatically.
+- Declare one or more menus in a dedicated `.toml` file.
+- Compose menu from multiple `.toml` files.
+- Declare a menu in a `pyproject.toml` directly.
+
+## Installation
+
+```console
+pip install menuet
+```
+
+## Usage
+
+Create a menu configuration in [TOML](https://toml.io/) format.
+
+```toml
+# menu.toml
+[[action]]
+id = "print-hello"
+label = "Print Hello"
+cb = "print('Hello')"
+group = "Some Separator"
+
+[[action]]
+id = "open-gui"
+label = "Open GUI"
+cb = "ep:myapp.gui:open_gui"
+menu = ["Foo", "Bar"]
+```
+
+Load the above configuration into a `Model` and pass
+that model to a Menu Builder to create a menu.
+
+```python
+from pathlib import Path
+from menuet.builders.text import Render, TextMenuBuilder
+from menuet.model import Model, loads
+
+model = Model()
+loads(Path("menu.toml").read_text(), model)
+
+builder = TextMenuBuilder(model, root_menu="Demo", render=Render.UTF8)
+print(builder.build())
+```
+
+```text
+Demo
+├── Foo
+│   └── Bar
+│       └── Open GUI
+├── Some Separator ───
+└── Print Hello
+```
+
+See the [documentation](https://tahv.codeberg.page/menuet/)
+for more advanced patterns.
+
+## Contributing
+
+For guidance on setting up a development environment and contributing, see
+[CONTRIBUTING.md](https://codeberg.org/tahv/menuet/src/branch/main/CONTRIBUTING.md).

menuet-1.0.0/changelog.d/template.md.jinja

@@ -0,0 +1,27 @@
+{%- if versiondata["version"] == "main" -%}
+## Changes for the Upcoming Release
+{% else -%}
+## [{{ versiondata["version"] }}](https://codeberg.org/tahv/menuet/releases/tag/{{ versiondata["version"] }}) - {{ versiondata["date"] }}
+{% endif %}
+{% for section, _ in sections.items() %}
+{% if sections[section] %}
+{% for category, val in definitions.items() if category in sections[section] %}
+
+### {{ definitions[category]['name'] }}
+
+{% for text, issues in sections[section][category].items() %}
+{% if ("\n\n" in text)%}
+{%- set t = text.split("\n\n", 1) %}
+{%- set text = [t[0], t[1]|indent(2, true)] | join("\n\n") + "\n" %}
+{% endif %}
+- {{ issues|join(',\n  ') }}:
+  {{ text }}
+{% endfor %}
+{% endfor %}
+
+{% else %}
+No significant changes.
+
+
+{% endif %}
+{% endfor %}

menuet-1.0.0/docs/api.md

@@ -0,0 +1,20 @@
+---
+icon: lucide/code
+---
+
+# API Reference
+
+::: menuet
+    options:
+      toc_label: "menuet"
+      filters: "public"
+
+::: menuet.builders.text
+    options:
+      toc_label: "menuet.builders.text"
+      filters: "public"
+
+::: menuet.builders.qt
+    options:
+      toc_label: "menuet.builders.qt"
+      filters: "public"

menuet-1.0.0/docs/configuration.md

@@ -0,0 +1,179 @@
+---
+icon: lucide/file-cog
+---
+
+# Menu Configuration
+
+The [`deserialize`][menuet.deserialize] function accepts a dict of `action`
+and `menu` lists.
+
+```python
+{
+    "action": [],
+    "menu": [],
+}
+```
+
+/// example
+
+```python
+import menuet
+from menuet.builders.text import Render, TextMenuBuilder
+
+model = menuet.Model()
+menuet.deserialize({
+    "menu": [
+        {
+            "label": "Sub-Menu",
+            "menu": ["My App"],
+            "group": "Separator",
+        },
+    ],
+    "action": [
+        {
+            "id": "open-gui",
+            "label": "Open GUI",
+            "cb": "import myapp; myapp.open_gui()",
+            "menu": ["My App", "Sub-Menu"],
+        },
+        {
+            "id": "print-hello",
+            "label":  "Print Hello",
+            "cb": 'print("Hello")',
+        },
+    ],
+    model,
+})
+
+builder = TextMenuBuilder(model, root_menu="Example", render=Render.UTF8)
+print(builder.build())
+```
+
+<div class="result" markdown>
+
+```text
+Example
+├── My App
+│   ├── Separator ───
+│   └── Sub-Menu
+│       └── Open GUI
+└── Print Hello
+```
+
+</div>
+
+///
+
+## Action Options
+
+The `[[action]]` tables accepts the following options:
+
+```toml { .copy }
+[[action]]                   # `action` is an array of action tables
+id = "my-action"             # unique identifier [required]
+label = "My Action"          # display name
+menu = ["Menu", "Sub-Menu"]  # parent menus hierarchy
+group = "My Group"           # group related menus and actions
+cb = "print('Hello !')"      # action callback
+desc = "Print Hello"         # tooltip
+icon = "icons/my-icon.png"   # path to an icon
+visible = true               # display action in menu
+enables = true               # allow action to be run
+```
+
+## Menu Options
+
+The `[[menu]]` tables accepts the following options:
+
+```toml { .copy }
+[[menu]]                    # `menu` is an array of menu tables
+label = "My Menu"           # display name [required]
+desc = "My App Scripts"     # tooltip
+menu = ["Parent Menu"]      # parent menus hierarchy
+group = "My Group"          # group related menus and actions
+icon = "icons/my-icon.png"  # path to an icon
+```
+
+Menus defined in `[[action]]` tables are created automatically.
+The only reason to configure `[[menu]]` explicitly is to set an `icon`,
+a `group`, or a `desc`.
+
+## `icon` Schemes
+
+<!-- TODO(tga): path relative to toml config -->
+
+The `icon` option accepts a value in the format `<path>` or `<scheme>:<value>`.
+
+The following schemes are available:
+
+- `path` *(default)*: takes a path to an icon file.
+
+    ```toml
+    icon = "icons/settings.png"
+
+    icon = "path:icons/settings.png"
+    ```
+
+- `res`: load a [resource file][importlib.resources.files].
+  Value is in the form `res:importable.module:file.ext`.
+
+    ```toml
+    icon = "res:myapp.data:logo.svg" 
+    ```
+
+## `cb` Schemes
+
+The `cb` option accepts a value in the format `<script>` or `<scheme>:<value>`.
+
+The following schemes are available:
+
+- `exec` *(default)*: takes a Python script.
+
+    ```toml
+    cb = "print('Hello !')"
+
+    cb = "exec:import myapp; myapp.open_gui()"
+
+    cb = """\
+    from importlib.metadata import version
+    print(version("myapp"))
+    """
+
+    cb = """exec:\
+    import myapp
+    myapp.open_gui()
+    """
+    ```
+
+- `ep`: loads an [entry point][importlib.metadata.EntryPoint].
+  Value is in the form `ep:importable.module:callable`.
+
+    ```toml
+    cb = "res:myapp.my_module:open_gui"
+
+    cb = "res:myapp:my_function"
+    ```
+
+- `copy`: copy its value to the clipboard.
+
+    ```toml
+    cb = "copy:Lorem ipsum dolor sit amet"
+    ```
+
+    /// warning
+
+    The `copy` scheme requires the
+    [copykitten](https://github.com/klavionik/copykitten) package,
+    available as an extra:
+
+    ```console { .copy }
+    pip install menuet[copy]
+    ```
+
+    ///
+
+- `url`: takes a URL and open it in the default browser.
+
+    ```toml
+    cb = "url:https://codeberg.org/tahv/menuet"
+    ```

menuet-1.0.0/docs/images/favicon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-music4-icon lucide-music-4"><path d="M9 18V5l12-2v13"/><path d="m9 9 12-2"/><circle cx="6" cy="18" r="3"/><circle cx="18" cy="16" r="3"/></svg>

menuet-1.0.0/docs/index.md

@@ -0,0 +1,5 @@
+---
+icon: lucide/home
+---
+
+--8<-- "README.md"