Components to be used with limbus.
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for limbus_components-0.1.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f08b254fafe1d9e52cd03c5b838477cb6c0d9a784cbbafd5255e7ec053f18920 |
|
MD5 | 3f8dba24a5995bfdd4b0dbf940a783bc |
|
BLAKE2b-256 | 7947612ff88040a971ebf7df362ebe8d9ae205718f794673e9ee9c5466e2b29c |