Skip to main content

Process-Oriented Programming (POP) SDK for Python

Project description

POP SDK (Process-Oriented Programming)

The "Operating System" for AI Agents and Complex Systems.

PyPI version License: MIT

POP (Process-Oriented Programming) is a paradigm shift designed for building robust, stateful AI agents. Unlike OOP which encapsulates state and behavior, POP decouples them completely to ensure:

  1. Transactional Integrity: Every action is atomic.
  2. Safety by Default: Inputs are immutable; outputs are strictly contracted.
  3. Observability: Every state change is logged and reversible.

🌟 Key Features

🛡️ Safety & Security

  • Context Locking ("The Vault"): Prevents accidental state mutation from external code (main.py). Warning mode by default, Strict mode (crash) for CI.
  • Frozen Inputs: Process inputs are wrapped in FrozenList/FrozenDict. Side-effects are blocked at runtime.
  • Strict Contracts: Explicit @process(inputs=[...], outputs=[...]) decorators prevent "State Spaghetti".

⚡ Developer Experience

  • POP CLI: Bootstrap new projects instantly with pop init.
  • Hybrid Guard: Friendly warnings for rapid dev, Strict enforcement for interaction.
  • Zero-Dependency Core: Pure Python. Compatible with PyTorch, TensorFlow, or any other library.

📦 Installation

pip install pop-sdk

🚀 Quick Start (CLI)

The fastest way to start is using the CLI tool to generate a standard project skeleton.

# 1. Initialize a new project
pop init my_agent

# 2. Enter directory
cd my_agent

# 3. Run the skeleton agent
python main.py

Arguments:

  • pop init <name>: Create a new project folder.
  • pop init .: Initialize in current directory.

📚 Manual Usage

1. Define Context (Data)

from dataclasses import dataclass
from pop import BaseGlobalContext, BaseDomainContext, BaseSystemContext

@dataclass
class MyGlobal(BaseGlobalContext):
    counter: int = 0

@dataclass
class MySystem(BaseSystemContext):
    global_ctx: MyGlobal
    # ... domain_ctx ...

2. Define Process (Logic)

from pop import process

@process(
    inputs=['global.counter'], 
    outputs=['global.counter']
)
def increment(ctx):
    # Valid: Declared in outputs
    ctx.global_ctx.counter += 1
    return "Incremented"

@process(inputs=['global.counter'], outputs=[])
def illegal_write(ctx):
    # INVALID: Read-Only Input
    # Raises ContractViolationError
    ctx.global_ctx.counter += 1 

3. Run Engine

from pop import POPEngine

system = MySystem(MyGlobal(), ...)
engine = POPEngine(system) # Default: Warning Mode

engine.register_process("inc", increment)
engine.run_process("inc")

⚙️ Configuration

You can control strictness via Environment Variables (supported in .env files):

Variable Values Description
POP_STRICT_MODE 1, true Enabled: Raises LockViolationError on unsafe external mutation.
Disabled (Default): Logs WARNING but allows mutation.

Safe External Mutation

To modify context from main.py without triggering warnings/errors, use the explicit API:

with engine.edit() as ctx:
    ctx.domain.my_var = 100

📄 License

MIT License. See LICENSE for details.

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

pop_sdk-0.2.0.tar.gz (22.7 kB view details)

Uploaded Source

Built Distribution

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

pop_sdk-0.2.0-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pop_sdk-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d52d53188653cacfca8b4316b7a5e1dbbbb6fb8822e64fdbcf3b1fa18ff440c6
MD5 50190b7dd9fff4013cffcff2c01fa268
BLAKE2b-256 79081e967a5a7269e8a599acf6319e25457a35ff237fb7e155dd467fa0c9a16e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pop_sdk-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 17.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for pop_sdk-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c281d58a0383353b167f56b912dc2521f50c80d7dab48214992903c0a4f6c153
MD5 f4acbf9be1dd43c4131f05e2a2895f7e
BLAKE2b-256 eed25a4c21f73787e120342b932040c6fa0138e141fbe8bf1c1aa964db650d58

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