How Tos - Tool

To know what is the role of a tool in Snooz, see Technical Overview.

Before creating your own tool

  • You need to have a properly configured development environment for Snooz.
  • Ensure that you have created your repository (e.g., my_snooz_repo) to manage your packages.
  • You have already explored Snooz and have an understanding of its structure.

How to create a tool

We use a command line to help create new tool. To access the terminal in VS Code, make sure to close Snooz beforehand.

  • In VS Code navigate to Terminal -> New Terminal

  • Select your repository you forked from snooz-package-template (e.g. my_snooz_repo)

  • Make sure the virtual environment snooz_310_env is activated (see Developer Installation)

  • In the terminal type : python main_utils.py

  • Select 3- Create a tool

  • Fill the information to suit your design. If you make any mistakes, just repeat the steps and it will ask to overwrite the previous one. If you need more information, see Tools.

How to create a custom step

TODO

How to create a configuration step

TODO

How to use a module’s settings page inside a step

TODO

How to add a resource to a step

TODO