Metadata-Version: 2.2
Name: compas_rui
Version: 0.4.2
Summary: Collection of components to build user interface in Rhino using COMPAS
Author-email: tom van mele <tom.v.mele@gmail.com>
License: MIT License
        
        ETH Zurich - Block Research Group
        
        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.
        
Project-URL: Homepage, https://blockresearchgroup.github.io/compas_rui
Project-URL: Documentation, https://blockresearchgroup.github.io/compas_rui
Project-URL: Repository, https://github.com/blockresearchgroup/compas_rui
Project-URL: Changelog, https://github.com/blockresearchgroup/compas_rui/blob/main/CHANGELOG.md
Project-URL: Issues, https://github.com/blockresearchgroup/compas_rui/issues
Project-URL: Forum, https://forum.compas-framework.org/
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: attrs>=17.4; extra == "dev"
Requires-Dist: black>=22.12.0; extra == "dev"
Requires-Dist: bump-my-version; extra == "dev"
Requires-Dist: compas_invocations2; extra == "dev"
Requires-Dist: invoke>=0.14; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: sphinx_compas2_theme; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: wheel; extra == "dev"

# COMPAS Rhino UI

This package containts a collection of components to build user interfaces in Rhino 8+ for COMPAS tools.

> [!WARNING]  
> This package can only be used inside of Rhino 8.
> In other environments it will simply not work...

## Installation

Stable releases can be installed from PyPI.

```bash
pip install compas_rui
```

To install the latest version for development, do:

```bash
git clone https://github.com/blockresearchgroup/compas_rui.git
cd compas_rui
pip install -e ".[dev]"
```

## Documentation

For further "getting started" instructions, a tutorial, examples, and an API reference,
please check out the online documentation here: [COMPAS Rhino UI docs](https://blockresearchgroup.github.io/compas_rui)

## Issue Tracker

If you find a bug or if you have a problem with running the code, please file an issue on the [Issue Tracker](https://github.com/blockresearchgroup/compas_rui/issues).
