Metadata-Version: 2.1
Name: maple-spec
Version: 0.0.2
Summary: A testing library for Speckle models
Author-email: Gizem Demirhan <gizemdemirhaan@gmail.com>, Andres Buitrago <andrsbtrg@gmail.com>
Project-URL: Homepage, https://github.com/andrsbtrg/maple
Project-URL: Issues, https://github.com/andrsbtrg/maple/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: specklepy

# Maple

## Automate your model Quality Check with Speckle and Maple

### About

Maple is a library designed to write simple code that can check
different attributes of a Model in Speckle.

Using Maple you can write `test specs` that check any parameter
or quantity inside the project model.

`Maple` can be integrated into [Speckle Automate](https://speckle.systems/blog/automate-with-speckle/)
to run the quality check tests on a continuous integration and ensure project standards.

### Get started

Simple case:

```py
import maple as mp

def spec_a():
    mp.it("checks window height is greater than 2600 mm")

    mp.get('category', 'Windows')\
        .where('speckle_type',
               'Objects.Other.Instance:Objects.Other.Revit.RevitInstance')\
        .its('Height')\
        .should('be.greater', 2600)


mp.stream("streamid")
mp.run(spec_a)
```

To run the examples locally, install the current package:

```sh
pip install .
python examples/specs.py

```
