kornia / limbus-components

Predefined components for limbus

Limbus-Components: Set of basic components for Limbus

This package is part of Limbus and contains a bunch of useful components.

Installation

This package can be automatically installed by Limbus. If you want to install it manually, you can do it with:

git clone https://github.com/kornia/limbus-components
cd limbus-components
pip install -e .

For development purposes, you can install it with:

pip install -e .[dev]  # also installs limbus

Dev Requirements

To add new components that must be done in the folder limbus_components_dev and then in order to release the changes you must run the the release script.

All the __init__.py files inside the folder limbus_components_dev must have the imports following the next patterns:

    from . import <component_module>  # to import modules
    from .<component_module> import <component_class0>, <component_class1>, ...  # to import components
    # IMPORTANT NOTE: imports with () are not allowed

if they are not following these patterns, the release script will fail. Check examples in the folder limbus_components_dev.

Steps to run the release script:

• If you changed an existing module, first of all you need to remove the module in limbus_components folder.
• Run the release script: python scripts/release.py
• Check that the changes in the limbus_components folder are the expected ones.
• commit the changes and push them to the repo.