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.3.tar.gz (18.5 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: runit-cli-0.3.3.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.3.tar.gz
Algorithm Hash digest
SHA256 6de7b13ca40bb8f68e3792f4fa192e294288f548ec4460f70800b65cc61cc80d
MD5 8721116d5eb6f6e67bbd99f130c20e6b
BLAKE2b-256 68ac521759ab61607020b37678561ec7f4c5e96cd7c6dab1ab571d1f048470d1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: runit_cli-0.3.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7e67cb2113bae6899637f63b639f7619cf3611689c49290d4a126e27447cb540
MD5 6acd90c3b3ff7836007b80ccfaf7d32a
BLAKE2b-256 e5e255f4f6dea3968575045702e67b0dcde2364c2ddade5d93b9d01c6bd6aba7

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