Skip to main content

A Python SDK for creating trustworthy AI agent transactions with Proof-of-Intent

Project description

PoI Python SDK Package

This folder contains the PyPI package for the Proof-of-Intent Python SDK.

Package Structure

package/
├── src/                    # Source code
│   └── poi_sdk/          # Main package
├── setup.py               # Package setup script
├── MANIFEST.in            # Package manifest
├── requirements.txt       # Dependencies
├── LICENSE                # MIT License
├── README.md              # This file
└── build_package.py       # Build automation script

Building the Package

Prerequisites

pip install setuptools wheel twine

Quick Build

cd package
python build_package.py

Manual Build

cd package

# Clean previous builds
rm -rf build dist *.egg-info

# Build source distribution
python setup.py sdist

# Build wheel
python setup.py bdist_wheel

# Check package
twine check dist/*

Package Contents

The package includes:

  • Core SDK: PoIReceipt, PoIGenerator, PoIValidator, PoIConfig
  • CLI Tool: poi-cli command-line interface
  • Type Hints: Full type annotation support
  • Dependencies: All required packages with version constraints

Installation

From PyPI (when published)

pip install poi-sdk

From Local Package

# Install from built wheel
pip install dist/poi_sdk-0.1.0-py3-none-any.whl

# Install in development mode
pip install -e .

Usage

from poi_sdk import PoIGenerator, PoIValidator

# Generate a receipt
generator = PoIGenerator()
receipt = generator.generate_receipt(
    agent_id="my_agent",
    action="data_access",
    target_resource="user_database",
    declared_objective="Fetch user profile"
)

# Validate the receipt
validator = PoIValidator()
is_valid = validator.validate_receipt(receipt)

CLI Usage

# Generate a receipt
poi-cli generate --agent-id "cli_agent" --action "test" --resource "test" --objective "Testing"

# Validate a receipt
poi-cli validate --receipt receipt.json

Development

For development setup and contribution guidelines, see the main repository's CONTRIBUTING.md.

License

MIT License - see LICENSE file 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

poi_sdk-0.1.0.tar.gz (16.1 kB view details)

Uploaded Source

Built Distribution

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

poi_sdk-0.1.0-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file poi_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: poi_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 16.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for poi_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 00a66306103ccebe8025e81e69952ccf3afb8da3694909348c3e766764510a06
MD5 9f5a0bec354c29fc031a7d536b342ee8
BLAKE2b-256 d6b1fa9f3af765438331c32f9ca09aea264c311e99d3e04f7ddfd344a70a46fd

See more details on using hashes here.

File details

Details for the file poi_sdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: poi_sdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for poi_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 27ed9359a4d169278aba8f90ebf5abc39f65672eda81a191966a0ed71bdcacd4
MD5 619b76e504411cd5b39fe2395c17f3fc
BLAKE2b-256 eb74aaad1ba4b990faf78ce21132b2a1b135ec7a2655b5ba0d3e86bc52278e74

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