semvec/pypi-packages huggingface dataset:
speedbeesynapse-sccde 0.1.11
This package provides some tools for developing custom components of SpeeDBee-Synapse.
Requires Python: >=3.10

# sccde

**speedbeesynapse-sccde** is a command line tool for developing custom components for [SpeeDBee Synapse](https://www.saltyster.com/speedbee-synapse/).

## Install

```sh
$ python3 -m venv .venv
$ . ./.venv/bin/activate
(.venv) $ pip3 install speedbeesynapse-sccde
```

## How to use

* Initialize environment:

    ```sh
    (.venv) $ sccde init
    (.venv) $ ls
    parameter_ui  scc-info.json  source
    ```

* Add component sample into the environment:

    ```sh
    (.venv) $ sccde add
    ```

* Make sccde package containing all custom components in the environment:

    ```sh
    (.venv) $ sccde make-package
    (.venv) $ ls
    custom_component_package_example.sccpkg  parameter_ui  scc-info.json  source
    ```

    You can use `.sccpkg` file for uploading to [SpeeDBee Synapse](https://www.saltyster.com/speedbee-synapse/)


* Check syntax and loadability for custom components in the environment:

    ```sh
    (.venv) $ sccde check --no-load
    Custom component package example (695c272b-5534-4702-9e6b-c09f8cbf8b60)
    Version: 0.1.0
    Description: Your package description here
    2 components:
    Sample collector(a43adb25-738e-4028-9ef0-1d569be94d9d)
        Read: OK
        Syntax: OK
        Load: NOT CHECKED
    Sample collector(a8193495-6433-446f-b3e5-cc49baae204e)
        Read: OK
        Syntax: OK
        Load: NOT CHECKED
    (.venv) $ sccde check
    Custom component package example (695c272b-5534-4702-9e6b-c09f8cbf8b60)
    Version: 0.1.0
    Description: Your package description here
    2 components:
    Sample collector(a43adb25-738e-4028-9ef0-1d569be94d9d)
        Read: OK
        Syntax: OK
        Load: NG
        | Traceback (most recent call last):
        |    :
        |   File "./source/python/sample_collector_1.py", line 109, in <module>
        |     raise Exception
        | Exception
        | 
    Sample collector(a8193495-6433-446f-b3e5-cc49baae204e)
        Read: OK
        Syntax: OK
        Load: OK
    Error: "Sample collector"
    ```