README.md

Python SDK

A rapid scripting platform for developers.

WayScript allows you to run Python in the cloud, and seamlessly integrate with your favorite APIs.

Installation

pip install wayscript

Basic Usage

1. Add one or more HTTP Triggers to your script.

2. If you have a password-protected endpoint, obtain your API key or the credentials you would like to use.

3. If you have specified a custom endpoint, you will need to pass the name of that endpoint in your api call.

4. If your HTTP Trigger takes query parameters and/or JSON body parameters, you can pass those as a dictionary using the params and/or data arguments, respectively. (See HTTP Trigger Outputs for more information.)

5. Run your WayScript programs from your Python code:

fromwayscriptimportWayScript# Create the WayScript clientwayscript=WayScript()
# If your program requires a password to run, supply those credentials when creating the clientusername='YOUR_USERNAME'password='YOUR_PASSWORD'kwargs= { 'username': username, 'password': password }
wayscript=WayScript( **kwargs )
# If your program requires a password to run, you can instead supply your API Key when creating the clientkwargs= { 'api_key': 'MY_API_KEY' }
wayscript=WayScript( **kwargs )
# Run a program by idprogram_id=1234wayscript.run( program_id )
# Pass query parameters for the HTTP Trigger to output (optional)query_params= { 'var1': 'one', 'var2': 'two', 'var3': 'three' }
wayscript.run( program_id, params=query_params )
# Pass JSON body parameters for the HTTP Trigger to output (optional)body_params= { 'var4': 'four', 'var5': 'five', 'var6': 'six' }
wayscript.run( program_id, data=body_params )
# Run a custom endpoint (optional)endpoint='my_endpoint'wayscript.run( program_id, endpoint=endpoint, params=query_params, data=body_params )
# Get the response from the serverresponse=wayscript.run( program_id )

Run a WayScript program from command line

PROGRAM_ID=1234
python -c "from wayscript import WayScript; WayScript().run($PROGRAM_ID)"

If you don't want to use Python on the command line, you can use cURL. (See the HTTP Trigger Sample Code for an example.)