Skip to main content

Develop serverless applications

Project description

Runit CLI Python

The Runit Command Line Interface (CLI) Tools can be used to test, manage, and deploy your Runit project from the command line.

  • Create new runit project
  • Run a local web server for your runit project
  • publish code and assets to your runit-server domain
  • Interact with data in your runit-server database

Supported Languages

Python JavaScript PHP

Installation

Python Package

You can install the Runit CLI using pip (Python package manager). Note that you will need to install Python. To download and install the runit CLI run the following command:

pip install runit

This will provide you with the globally accessible runit command.

Install from source

git clone https://github.com/theonlyamos/runit.git
cd runit
pip install .

Usage

Run the below command to print out usage message.

runit --help

Runit Cli

Create New Project Run the following in the command line to create a new runit project.

Supported languages include: Python, Javascript, PHP

runit new <project-name> --language <langugage>

Run runit new --help for all options

Run project locally Access functions on local server* Running the command runit in a project directory spins up a local webserver which can be used to access the funtions in project.

cd <project-directory>
runit

Point your browser to the address provided followed by the function name to access that function. http://localhost:5000/ will be the default address. Visiting http://localhost:5000/hello_world will run the hello_world function in the project.

Run function and print output to shell Output function result to shell. Required arguments include:

--function <function_name>: Function name to call --shell: sets shell output to true [Optional] --arguments|-x: Arguments for the function if required. Can be called multiple times for multiple arguments

cd <project-directory>
runit --function <hello_world> --shell

Publishing Project

Before you can publish any of your projects, you must setup the backend for your runit. You must also be logged in.

Setup Backend Details The backend must be running runit-server. Run runit setup --help for help message. Follow the prompts to complete the setup after running the below comman.

runit setup

Account Login

runit login --help
runit login --email <email@example.org> --password <supersecretpass>

or Follow the commands after running below command

runit login

Deploy/Publish Project

cd <project-directory>
runit publish

License

License

Free Software, Hell Yeah!

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

runit-cli-0.3.4.tar.gz (18.5 kB view details)

Uploaded Source

Built Distribution

runit_cli-0.3.4-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

Details for the file runit-cli-0.3.4.tar.gz.

File metadata

  • Download URL: runit-cli-0.3.4.tar.gz
  • Upload date:
  • Size: 18.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for runit-cli-0.3.4.tar.gz
Algorithm Hash digest
SHA256 1f01afd4249687683f7fb96111de7c12cbe191098aa13ea4a9fcefb3c798567c
MD5 6e098f991a33e19c99fe706be3683378
BLAKE2b-256 171d3881bd554ed1a235d730224afaca3d2a5502d235d44d55200c6b9316937b

See more details on using hashes here.

File details

Details for the file runit_cli-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: runit_cli-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 21.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for runit_cli-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5818cb6f21d351e85b3d413e2304fd6f7dc5a8c322016b799975d2ee6ffd922e
MD5 48face0ec77f35cec14ce91d1593d7c1
BLAKE2b-256 99e641a631861f6fa7cefe7802305ed6ef64e1630bfe34345172589337f7d8ac

See more details on using hashes here.

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