Files
speckle-automate-checker/README.md
Jonathon Broughton b7ff0137b1 Split Readmes (#15)
* Add project configuration and refactor logic

- Created .gitignore to exclude IDE files.
- Added project module configuration for Python.
- Set up inspection profiles for code quality checks.
- Refactored main function logic into separate modules for better organisation.
- Introduced helper functions for object manipulation and rule processing.
- Implemented spreadsheet reading functionality to dynamically load rules.
- Added tests for integration with the Speckle server.

* Add developer guide

- Introduced a new developer README with setup, project structure, testing, and deployment instructions.
- Revised the primary README to reflect changes in functionality and usage instructions for the Checker function.
2025-02-06 21:33:18 +00:00

857 B

Public Function: Checker

Validate Speckle objects against configurable rules using spreadsheet definitions.

Usage

  1. Access the template Google Sheet [link needed]
  2. Make a copy to your Google Drive using File > Make a copy
  3. Define your rules in your sheet
  4. Click "Speckle" menu > "Publish Rules" to get your TSV URL
  5. Create an Automation in Speckle Automate using the Checker function
  6. Paste your TSV URL into the function configuration
  7. Run your automation

Rule Types

  • Property existence
  • Value matching
  • Numeric comparisons
  • Range checks
  • List membership
  • Pattern matching
  • Boolean checks

Severity Levels

  • WARNING: Issues that should be reviewed
  • ERROR: Critical issues requiring attention

Example Rules

[Screenshot or example table to be added]

Support

For issues or questions, please open a GitHub issue.