pinnacle-python 0.0.2

No project description provided

Pinnacle Python Client

This is the official Python client for the Pinnacle Serverless Backend API.

Pre-requisites

• Python 3.12 or higher

Usage

1. Install the package using pip:

pip install pinnacle-python

2. To define an endpoint, use the @endpoint decorator:

from pinnacle_python import endpoint

@endpoint
def hello_world():
    return "Hello, World!"

This will create a POST endpoint at /hello_world with no parameters.

3. To define a scheduled script, use the @scheduled decorator:

from pinnacle_python import schedule, Period
@schedule(
    for_time=datetime.datetime.today() + timedelta(minutes=1), 
    repeats=Period(seconds=2)
)
def test_job():
    print("Hello, world!")

This will run the test_job function every 2 seconds starting 1 minute from the time the script is deployed. See the schedule documentation for more information on how to configure the schedule.

4. Install the Pinnacle CLI:

pip install pinnacle-cli

5. Deploy the endpoint using the CLI:

pinnacle dev

6. You can now access the endpoint at http://localhost:8000/hello_world. Calling the endpoint

curl -X POST http://localhost:8000/hello_world \
     -H "Content-Type: application/json" \
     -d '{}'

will return a JSON in the following format:

{
    "data": "Hello, World!"
}

Environment Variables

See the Pinnacle CLI README for a list of environment variables that can be used to configure the Pinnacle CLI.