Skip to main content

This utility helps you deploy your code as an API locally on your machine

Project description

rio-cli

PyPI version pypi supported versions

This utility helps you deploy your code as an API locally on your machine using Docker. It is a python based package that can be installed via pip.

Quickstart

  1. Install rio: pip install rio-chopt

  2. Deploy your package : rio deploy -l path/to/package/folder

    eg: rio deploy -l /Users/abcdef@ghi.com/Documents/git/myProject

    Note: you will be prompted to enter your docker hub username, password, and email

You can find a sample project here.


- Deploy Package Arguments and Options

rio deploy -l path/to/package/folder

  • -l is for local deployment (only local is available for now).
  • -n is for specifying a package name. If left out, the folder name is chosen as package name.
  • -p is a port you specify for it to be spun up on(The valid range is 1024-65535). If left out, a port will be assigned.
  • -q is to deploy with no extra prompts to affirm redeployments and no webpage opening when finishing the deployment.

- Re-deploying a package.

rio deploy -l path/to/package/folder

If you used a custom name for your package, you will have to specify it with the package name (-n) flag just like you did initially.

e.g. rio deploy -l /Users/abcdef@ghi.com/Documents/git/myUpdatedProject or

rio deploy -l -n myCustomName /Users/abcdef@ghi.com/Documents/git/myUpdatedProject

Note: It will re-use the port from the first deployment.


Other commands:

Description Command
List packages deployed rio list -l
Stop a package ¹ rio stop -l myProject
Stop all packages rio stop -l --all
Start a package rio start -l myProject
Start all packages rio start -l --all
Undeploy a package rio undeploy -l myProject
Undeploy all packages rio undeploy -l --all
Begin RIO session ² ³ rio begin -l
End RIO session rio end -l

¹ If a model API associated with this package is running, you will be asked to enter 'Y' to stop it and proceed with deleting the package.

² A RIO Session begins automatically upon running rio deploy or rio list.

³ You can also point to a yaml file like this: rio begin -l -f /Users/myUser/Documents/docker-creds.yaml. Download a sample credential file here.

You can use the --help command in front of any command from within the CLI for help with options and arguments.
Eg: rio deploy --help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rio-chopt-1.0.4.2.tar.gz (21.8 kB view hashes)

Uploaded Source

Built Distribution

rio_chopt-1.0.4.2-py3-none-any.whl (29.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page