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.2.0.tar.gz (16.8 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.2.0-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for workpeg-0.2.0.tar.gz
Algorithm Hash digest
SHA256 670a458398c66ccc3449b05b92ff11c88af9f20575722cc2b29e2a95c119224a
MD5 89fadde51dd0b44f4486e96d903c5708
BLAKE2b-256 4cbf042ed98ab353b5204e6c1717e7e35c007b13c75f18ab13231617eb55ee6b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: workpeg-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 15.1 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 364f3289266e7469b1478631da39577840fceb368f544aa1bf7f4c0dc16d1ff9
MD5 0cf3bb334b95bee613d2794eae47bbba
BLAKE2b-256 494e254de0697acc83a2abf24f0a720146066ba69bbda18dbaa614a48b638652

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