poi-sdk


Namepoi-sdk JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/giovannypietro/poi-examples
SummaryA Python SDK for creating trustworthy AI agent transactions with Proof-of-Intent
upload_time2025-08-24 21:27:36
maintainerNone
docs_urlNone
authorGiovanny Pietro
requires_python>=3.8
licenseNone
keywords proof-of-intent ai security cryptography agents trust audit
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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

```bash
pip install setuptools wheel twine
```

### Quick Build

```bash
cd package
python build_package.py
```

### Manual Build

```bash
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)

```bash
pip install poi-sdk
```

### From Local Package

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

# Install in development mode
pip install -e .
```

## Usage

```python
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

```bash
# 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](../CONTRIBUTING.md).

## License

MIT License - see [LICENSE](LICENSE) file for details.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/giovannypietro/poi-examples",
    "name": "poi-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "proof-of-intent, ai, security, cryptography, agents, trust, audit",
    "author": "Giovanny Pietro",
    "author_email": "giovanny.pietro@example.com",
    "download_url": "https://files.pythonhosted.org/packages/d6/b1/fa9f3af765438331c32f9ca09aea264c311e99d3e04f7ddfd344a70a46fd/poi_sdk-0.1.0.tar.gz",
    "platform": null,
    "description": "# PoI Python SDK Package\n\nThis folder contains the PyPI package for the Proof-of-Intent Python SDK.\n\n## Package Structure\n\n```\npackage/\n\u251c\u2500\u2500 src/                    # Source code\n\u2502   \u2514\u2500\u2500 poi_sdk/          # Main package\n\u251c\u2500\u2500 setup.py               # Package setup script\n\u251c\u2500\u2500 MANIFEST.in            # Package manifest\n\u251c\u2500\u2500 requirements.txt       # Dependencies\n\u251c\u2500\u2500 LICENSE                # MIT License\n\u251c\u2500\u2500 README.md              # This file\n\u2514\u2500\u2500 build_package.py       # Build automation script\n```\n\n## Building the Package\n\n### Prerequisites\n\n```bash\npip install setuptools wheel twine\n```\n\n### Quick Build\n\n```bash\ncd package\npython build_package.py\n```\n\n### Manual Build\n\n```bash\ncd package\n\n# Clean previous builds\nrm -rf build dist *.egg-info\n\n# Build source distribution\npython setup.py sdist\n\n# Build wheel\npython setup.py bdist_wheel\n\n# Check package\ntwine check dist/*\n```\n\n## Package Contents\n\nThe package includes:\n\n- **Core SDK**: `PoIReceipt`, `PoIGenerator`, `PoIValidator`, `PoIConfig`\n- **CLI Tool**: `poi-cli` command-line interface\n- **Type Hints**: Full type annotation support\n- **Dependencies**: All required packages with version constraints\n\n## Installation\n\n### From PyPI (when published)\n\n```bash\npip install poi-sdk\n```\n\n### From Local Package\n\n```bash\n# Install from built wheel\npip install dist/poi_sdk-0.1.0-py3-none-any.whl\n\n# Install in development mode\npip install -e .\n```\n\n## Usage\n\n```python\nfrom poi_sdk import PoIGenerator, PoIValidator\n\n# Generate a receipt\ngenerator = PoIGenerator()\nreceipt = generator.generate_receipt(\n    agent_id=\"my_agent\",\n    action=\"data_access\",\n    target_resource=\"user_database\",\n    declared_objective=\"Fetch user profile\"\n)\n\n# Validate the receipt\nvalidator = PoIValidator()\nis_valid = validator.validate_receipt(receipt)\n```\n\n## CLI Usage\n\n```bash\n# Generate a receipt\npoi-cli generate --agent-id \"cli_agent\" --action \"test\" --resource \"test\" --objective \"Testing\"\n\n# Validate a receipt\npoi-cli validate --receipt receipt.json\n```\n\n## Development\n\nFor development setup and contribution guidelines, see the main repository's [CONTRIBUTING.md](../CONTRIBUTING.md).\n\n## License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Python SDK for creating trustworthy AI agent transactions with Proof-of-Intent",
    "version": "0.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/giovannypietro/poi-examples/issues",
        "Documentation": "https://github.com/giovannypietro/poi-examples/blob/main/README.md",
        "Homepage": "https://github.com/giovannypietro/poi-examples",
        "Source Code": "https://github.com/giovannypietro/poi-examples"
    },
    "split_keywords": [
        "proof-of-intent",
        " ai",
        " security",
        " cryptography",
        " agents",
        " trust",
        " audit"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "eb74aaad1ba4b990faf78ce21132b2a1b135ec7a2655b5ba0d3e86bc52278e74",
                "md5": "619b76e504411cd5b39fe2395c17f3fc",
                "sha256": "27ed9359a4d169278aba8f90ebf5abc39f65672eda81a191966a0ed71bdcacd4"
            },
            "downloads": -1,
            "filename": "poi_sdk-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "619b76e504411cd5b39fe2395c17f3fc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 17556,
            "upload_time": "2025-08-24T21:27:35",
            "upload_time_iso_8601": "2025-08-24T21:27:35.513462Z",
            "url": "https://files.pythonhosted.org/packages/eb/74/aaad1ba4b990faf78ce21132b2a1b135ec7a2655b5ba0d3e86bc52278e74/poi_sdk-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d6b1fa9f3af765438331c32f9ca09aea264c311e99d3e04f7ddfd344a70a46fd",
                "md5": "9f5a0bec354c29fc031a7d536b342ee8",
                "sha256": "00a66306103ccebe8025e81e69952ccf3afb8da3694909348c3e766764510a06"
            },
            "downloads": -1,
            "filename": "poi_sdk-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9f5a0bec354c29fc031a7d536b342ee8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 16136,
            "upload_time": "2025-08-24T21:27:36",
            "upload_time_iso_8601": "2025-08-24T21:27:36.983192Z",
            "url": "https://files.pythonhosted.org/packages/d6/b1/fa9f3af765438331c32f9ca09aea264c311e99d3e04f7ddfd344a70a46fd/poi_sdk-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-24 21:27:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "giovannypietro",
    "github_project": "poi-examples",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "poi-sdk"
}
        
Elapsed time: 4.14485s