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. Create a directory called pinnacle and create a file called main.py in the directory. This directory will contain all your endpoint definitions.
3. 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.

4. 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.

5. Install the Pinnacle CLI:

pip install pinnacle-cli

6. Deploy the endpoint using the CLI:

pinnacle dev

7. 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!"
}

Defining response models

If you want to define a response model for your endpoint, provide the return type for the endpoint function:

from pinnacle_python import endpoint
@endpoint()
def hello_world() -> int:
    return 1

Or, if you want to return a more complex object use Pydantic's BaseModel class:

from pydantic import BaseModel
from pinnacle_python import endpoint

class Person(BaseModel):
    name: str
    message: str


@endpoint()
def hello_world() -> Person:
    return Person(name="John", message="Hello, World!")

Environment Variables

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