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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

runit_cli-0.4.4-py3-none-any.whl (43.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: runit_cli-0.4.4.tar.gz
  • Upload date:
  • Size: 38.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for runit_cli-0.4.4.tar.gz
Algorithm Hash digest
SHA256 bff7f7380fd3afd27dbc37bc0b167475d442fed21d5d1dc4348274ee1926e1aa
MD5 d79ac336448e525340b675bbe96c9eda
BLAKE2b-256 cbe553b1f99c949a4ba8afd5fb20ea6f556eff90612733280acf592e46b84bc8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: runit_cli-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 43.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for runit_cli-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f87454e78d5f66bef27a28d6756ad523e631f42cd6e72b7491e7df8bae64f340
MD5 1e096eb55d5437198755bbdfdd816fdd
BLAKE2b-256 fecbe29b1317a923baedb405d346ab4548049703ffe46adcaf1630a24932b6f0

See more details on using hashes here.

Supported by

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