Skip to main content

Workpeg function runtime and SDK

Project description

Workpeg SDK

Python SDK for building Workpeg functions and Pegs.

The SDK provides tools to:

  • Create new Workpeg function projects
  • Run functions locally
  • Submit function packages to the Workpeg registry

More features are coming, including Peg development tools, UI capabilities, and deployment workflows.

Repository https://gitlab.com/workpeg/workpeg-sdk


Installation

pip install workpeg

Or install from source:

pip install -e .

Getting Started

1. Create a new function project

workpeg new-function my-function

This creates a project scaffold like:

my-function/
  app/
    __init__.py
    main.py

Your function lives in app/main.py.

Example:

def main(context, payload):
    return {
        "message": "Hello from Workpeg",
        "payload": payload
    }

2. Run locally

Functions are executed through the runtime.

Example:

echo '{"context": {}, "payload": {"name": "world"}}' | workpeg runtime

Output:

{
  "status": "success",
  "result": {
    "message": "Hello from Workpeg",
    "payload": {"name": "world"}
  }
}

The runtime expects input in this format:

{
  "context": {...},
  "payload": {...}
}

3. Submit a function

Package your function and submit it to the Workpeg registry.

workpeg submit my-function:1.0.0

Authentication is provided through the WORKPEG_PK environment variable.

Example:

export WORKPEG_PK=<your-token>

The function will be uploaded to:

https://repo.workpeg.com

Function Entrypoint

By default the runtime loads:

app.main:main

You can override this using an environment variable:

FUNCTION_ENTRYPOINT=module.path:function

Example:

FUNCTION_ENTRYPOINT=app.main:handler workpeg runtime

Project Structure

Typical function project:

my-function
 ├─ app
 │  ├─ __init__.py
 │  └─ main.py
 └─ requirements.txt

Roadmap

The SDK will expand to support:

  • Peg development tooling
  • UI features for building Peg interfaces
  • Packaging and deployment workflows
  • Function sandboxing and execution tooling

Documentation

Full documentation is coming soon.


License

MIT License

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

workpeg-0.1.2.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

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

workpeg-0.1.2-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file workpeg-0.1.2.tar.gz.

File metadata

  • Download URL: workpeg-0.1.2.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for workpeg-0.1.2.tar.gz
Algorithm Hash digest
SHA256 29703ddba0dc853722b95da89b57598ec63a6c161265b61b28dba658a328ff82
MD5 91482049cec04d707164d8f913255ce9
BLAKE2b-256 fea984201d0497b09f49515225e42c5019273f74d8bb218b38693fad1b112585

See more details on using hashes here.

File details

Details for the file workpeg-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: workpeg-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for workpeg-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 88a04e8e742f8e25ed4c2020aef4c704346a9a5cd9b51e58468081f31a877bc7
MD5 9bde7255faa3dc9d3303020f5d9a71f7
BLAKE2b-256 f0e5c5f85ad7c4a91758c7f15dc3ff18e04a9ba909be8962a5827fe428e19820

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