Home

The Rio CLI is a command-line tool to interact with the Rapyuta.io Platform. It is built using the Click Framework, and the Rapyuta.io’s Python SDK.

Development

The project uses Pipenv for development. Install Pipenv, and then bootstrap the virtual environment with development dependencies.

pip install pipenv
pipenv install --dev

To run the Rio CLI from source directly, either invoke the Python module directly, or install it in editable mode.

# Start Pipenv shell
pipenv shell

# Invoke Python module
python -m riocli

# Install in editable mode
pip install --editable .

Contribute

The project uses Github Workflow for Issues and Pull Requests. Please read the Workflow before contributing to the Project.

Github Actions are configured on the Repository to automate the Release process. It uses Semantic Release to automate the steps. We require contributors to follow Conventional Commits to author the Git commit messages to auto-generate the Changelog for release.

Release

Each release is tracked using the Github Milestones. Maintainers are required to include the Issues and Pull Requests under the Milestone. All the included items must be completed to cut the Release.

To do the release, get all the changes merged in the devel branch. Then, create a Pull Request from devel to main branch with the name Release vX.X.X. Once the branch gets merged, Github Actions will kick-in and perform following actions:

• Update Changelog and Bump CLI Version following Semantic Versioning.
• Publish the Github Release.
• Add released tag and comment in all the merged Pull Requests.
• Generate the documentation in gh-pages branch.
• Upload the module to Pypi.