Getting Started

This documentation is under construction. Please give us your feedbacks by contacting us at hub@gencovery.com.
Creation of a brick
The skeleton brick is provided to ease the creation of new Constellab brick.
To create a new brick, please

  1. Go to Constellab and switch to your digital lab
  2. Enter in the VS code development environment of your digital lab (the codelab)
  3. Open VS code on the user folder /lab/user/.
  4. Ensure that the skeleton brick folder exists in the directory ./user/bricks/.
  5. Open the Terminal and type the following commands to create a brick named foo
    1. cd skeleton
    2. bash python3 utils/create_brick.py --name foo

A new brick with the name foo will appear in the directory ./user/bricks.
Brick structure
The structure of your new brick should be

    ├── LICENSE
    ├── README.md
    ├── manage.py
    ├── pyproject.toml
    ├── settings.json
    ├── setup.py
    ├── src
    │   └── foo
    │       ├── __init__.py
    │       ├── app.py
    │       ├── cli.py
    │       └── data.py
    ├── tests
    │   ├── __init__.py
    │   └── test_data.py
    └── utils
        └── create_brick.py

Please check that the folder foo exists in the ./src directory.
Brick description and publication
It is highly recommended to describe your brick before publishing it. To describe your brick, you only need to fill the file README.md.
To allow Constellab to deploy and install a user brick in a lab, this bricks must be published on a public or private remote git or pip server.
Git versioning and publication
It is currently recommended to version and publish your brick using git. Any remote git server such as Github or Gitlab is compatible with Constellab.
PIP publication
In the next future, it will be possible to publish brick using pip.