Here we provide some guides for the development of Rubrix.
git clone https://github.com/[your-github-username]/rubrix.git cd rubrix
To keep your fork’s master branch up to date with our repo you should add it as an upstream remote branch:
git remote add upstream https://github.com/recognai/rubrix.git
Now go ahead and create a new conda environment in which the development will take place and activate it:
conda env create -f environment_dev.yml conda activate rubrix
In the new environment Rubrix will already be installed in editable mode with all its server dependencies.
To keep a consistent code format, we use pre-commit hooks. You can install them by simply running:
Install the commit-msg hook if you want to check your commit messages in your contributions:
pre-commit install --hook-type commit-msg
The last step is to build the static UI files in case you want to work on the UI:
If you want to run the web app now, simply execute:
python -m rubrix
Congrats, you are ready to take Rubrix to the next level 🚀
Building the documentation¶
To build the documentation, make sure you set up your system for Rubrix development.
Then go to the docs folder in your cloned repo and execute the
cd docs make html
This will create a
_build/html folder in which you can find the
index.html file of the documentation.