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

Uploaded Source

Built Distribution

runit_cli-0.4.3-py3-none-any.whl (38.8 kB view details)

Uploaded Python 3

File details

Details for the file runit_cli-0.4.3.tar.gz.

File metadata

  • Download URL: runit_cli-0.4.3.tar.gz
  • Upload date:
  • Size: 32.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for runit_cli-0.4.3.tar.gz
Algorithm Hash digest
SHA256 44b1e3555881808b92d3c2c4761142a2c202ec3115d6740a1009f94cde838fc0
MD5 1233dfffcff87ad57237b3ac0ee537d4
BLAKE2b-256 ceca75e52c672808aa01c86d893af26fb5da803ea77e339489d3df420e7cd065

See more details on using hashes here.

File details

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

File metadata

  • Download URL: runit_cli-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 38.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for runit_cli-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5974597a0c26c820ce79f35f8b85e9ef86aae1afc3b22415725c4adcc15c910b
MD5 d769f723408f19d2158a08ccc71bc378
BLAKE2b-256 fb5ce48b659d0d447b46cf9ba73afc4985191abe2796a80ba3b22a955c375813

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