| Name | ironbook-sdk JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Python SDK for Iron Book by Identity Machines |
| upload_time | 2025-07-23 15:26:30 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
|
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Iron Book Python SDK
A Python SDK for interacting with Iron Book by Identity Machines. This SDK provides seamless integration with Iron Book's agent registration, authentication, and policy decision APIs.
## Features
- **Agent Registration**: Register new agents and obtain Verifiable Credentials
- **Authentication**: Get authentication tokens for agent operations
- **Policy Decisions**: Evaluate policy decisions for agent actions
- **Policy Upload**: Upload a new access control policy to enforce actions against
- **Async Support**: Full async/await support for high-performance applications
- **Type Safety**: Comprehensive type hints and dataclass definitions
- **Modern HTTP Client**: Built on httpx for reliable HTTP operations
## Installation
```bash
pip install ironbook-sdk
```
## Quick Start
```python
import asyncio
from ironbook_sdk import IronBookClient, RegisterAgentOptions, GetAuthTokenOptions, PolicyInput
async def main():
# Initialize the client
client = IronBookClient(api_key="your-api-key")
# Register a new agent
register_options = RegisterAgentOptions(
agent_name="my-agent",
capabilities=["query", "read"],
developer_did="did:web:example.com" # Optional
)
vc = await client.register_agent(register_options)
print(f"Agent registered with VC: {vc}")
# Get authentication token
auth_options = GetAuthTokenOptions(
agent_did="did:web:agent.example.com",
vc=vc,
audience="https://api.identitymachines.com",
developer_did="did:web:example.com" # Optional
)
token_data = await client.get_auth_token(auth_options)
print(f"Auth token: {token_data}")
# Make a policy decision
policy_input = PolicyInput(
did="did:web:agent.example.com",
token=token_data["access_token"],
action="query",
resource="db://finance/tx"
)
decision = await client.policy_decision(policy_input)
print(f"Policy decision: {decision.allow}")
# Run the async function
asyncio.run(main())
```
## API Reference
### IronBookClient
The main client class for interacting with Iron Book APIs.
#### Constructor
```python
IronBookClient(api_key: str, base_url: str = "https://dev.identitymachines.com")
```
**Parameters:**
- `api_key` (str): Your Iron Book API key
- `base_url` (str, optional): Base URL for the API. Defaults to development environment.
#### Methods
##### register_agent(opts: RegisterAgentOptions) -> str
Registers a new agent and returns a Verifiable Credential.
```python
vc = await client.register_agent(RegisterAgentOptions(
agent_name="my-agent",
capabilities=["query", "read"],
developer_did="did:web:example.com" # Optional
))
```
##### get_auth_token(opts: GetAuthTokenOptions) -> Dict[str, Any]
Gets an authentication token for an agent.
```python
token_data = await client.get_auth_token(GetAuthTokenOptions(
agent_did="did:web:agent.example.com",
vc=vc,
audience="https://api.identitymachines.com",
developer_did="did:web:example.com" # Optional
))
```
##### policy_decision(opts: PolicyInput) -> PolicyDecision
Gets a policy decision for an agent action.
```python
decision = await client.policy_decision(PolicyInput(
did="did:web:agent.example.com",
token="jwt-token",
action="query",
resource="db://finance/tx",
context={"amount": 1000, "ticker": "AAPL"}
))
```
## Data Types
### RegisterAgentOptions
Options for registering a new agent.
```python
@dataclass
class RegisterAgentOptions:
agent_name: str # Name of the agent
capabilities: List[str] # List of agent capabilities
developer_did: Optional[str] # Developer's DID (optional)
```
### GetAuthTokenOptions
Options for getting an authentication token.
```python
@dataclass
class GetAuthTokenOptions:
agent_did: str # Agent's DID
vc: str # Verifiable Credential
audience: str # Token audience (e.g., API endpoint)
developer_did: Optional[str] # Developer's DID (optional)
```
### PolicyInput
Input parameters for policy decision.
```python
@dataclass
class PolicyInput:
did: str # Agent DID (subject)
token: str # Short-lived access token (JWT)
action: str # Action (e.g., "query")
resource: str # Resource (e.g., "db://finance/tx")
context: Optional[Dict[str, Any]] # Optional context (amount, ticker, etc.)
```
### PolicyDecision
Result of a policy decision evaluation.
```python
@dataclass
class PolicyDecision:
allow: bool # Whether the action is allowed
evaluation: Optional[List[Any]] # Policy evaluation details
reason: Optional[str] # Reason for the decision
```
### PolicyDecisionResult
Enumeration for policy decision results.
```python
class PolicyDecisionResult(str, Enum):
ALLOW = "allow"
DENY = "deny"
```
### UploadPolicyOptions
Options for uploading a policy.
```python
@dataclass
class UploadPolicyOptions:
agent_did: str # Agent's DID
config_type: str # Configuration type
policy_content: str # Policy content
metadata: Any # Policy metadata
developer_did: Optional[str] # Developer's DID (optional)
```
## Advanced Usage
### Error Handling
```python
import asyncio
from ironbook_sdk import IronBookClient
async def safe_agent_operation():
client = IronBookClient(api_key="your-api-key")
try:
# Your operations here
vc = await client.register_agent(...)
return vc
except Exception as e:
print(f"Error: {e}")
return None
asyncio.run(safe_agent_operation())
```
### Custom Base URL
```python
# Use production environment
client = IronBookClient(
api_key="your-api-key",
base_url="https://api.identitymachines.com"
)
```
### Policy Decision with Context
```python
# Make a policy decision with rich context
decision = await client.policy_decision(PolicyInput(
did="did:web:agent.example.com",
token="jwt-token",
action="transfer",
resource="bank://account/123",
context={
"amount": 5000,
"currency": "USD",
"recipient": "alice@example.com",
"timestamp": "2024-01-15T10:30:00Z"
}
))
if decision.allow:
print("Transfer approved")
if decision.reason:
print(f"Reason: {decision.reason}")
else:
print("Transfer denied")
if decision.reason:
print(f"Reason: {decision.reason}")
```
### Upload Policy
```python
# Upload a new access control policy
upload_options = UploadPolicyOptions(
agent_did="did:web:agent.example.com",
config_type="opa",
policy_content="package policy\nallow { input.action == \"read\" }",
metadata={"version": "1.0", "description": "Read-only policy"},
developer_did="did:web:example.com" # Optional
)
result = await client.upload_policy(upload_options)
print(f"Policy uploaded: {result}")
```
## Development
### Setting up the development environment
```bash
# Clone the repository
git clone https://github.com/your-org/ironbook-sdk-python.git
cd ironbook-sdk-python
# Install development dependencies
pip install -e .
pip install pytest pytest-asyncio
# Run tests
pytest
```
### Building and publishing
```bash
# Install build tools
pip install build twine
# Build the package
python -m build
# Test upload to TestPyPI
twine upload --repository testpypi dist/*
# Upload to PyPI (when ready)
twine upload dist/*
```
## Support
- **Documentation**: [https://docs.identitymachines.com](https://docs.identitymachines.com)
- **Issues**: [GitHub Issues](https://github.com/your-org/ironbook-sdk-python/issues)
- **Email**: devops@identitymachines.com
## Changelog
### 0.1.0
- Initial release
- Agent registration functionality
- Authentication token generation
- Policy decision evaluation
- Policy upload functionality
- Async/await support
- Comprehensive type hints
- Context manager support for client lifecycle management
- Convenience functions for simplified usage
Raw data
{
"_id": null,
"home_page": null,
"name": "ironbook-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Identity Machines <devops@identitymachines.com>",
"download_url": "https://files.pythonhosted.org/packages/ae/f2/8076ad5c697f8fa3e8e840cea2be7ca165e6d774c2d1c7e0a4f7519faf3e/ironbook_sdk-0.1.1.tar.gz",
"platform": null,
"description": "# Iron Book Python SDK\n\nA Python SDK for interacting with Iron Book by Identity Machines. This SDK provides seamless integration with Iron Book's agent registration, authentication, and policy decision APIs.\n\n## Features\n\n- **Agent Registration**: Register new agents and obtain Verifiable Credentials\n- **Authentication**: Get authentication tokens for agent operations\n- **Policy Decisions**: Evaluate policy decisions for agent actions\n- **Policy Upload**: Upload a new access control policy to enforce actions against\n- **Async Support**: Full async/await support for high-performance applications\n- **Type Safety**: Comprehensive type hints and dataclass definitions\n- **Modern HTTP Client**: Built on httpx for reliable HTTP operations\n\n## Installation\n\n```bash\npip install ironbook-sdk\n```\n\n## Quick Start\n\n```python\nimport asyncio\nfrom ironbook_sdk import IronBookClient, RegisterAgentOptions, GetAuthTokenOptions, PolicyInput\n\nasync def main():\n # Initialize the client\n client = IronBookClient(api_key=\"your-api-key\")\n \n # Register a new agent\n register_options = RegisterAgentOptions(\n agent_name=\"my-agent\",\n capabilities=[\"query\", \"read\"],\n developer_did=\"did:web:example.com\" # Optional\n )\n \n vc = await client.register_agent(register_options)\n print(f\"Agent registered with VC: {vc}\")\n \n # Get authentication token\n auth_options = GetAuthTokenOptions(\n agent_did=\"did:web:agent.example.com\",\n vc=vc,\n audience=\"https://api.identitymachines.com\",\n developer_did=\"did:web:example.com\" # Optional\n )\n \n token_data = await client.get_auth_token(auth_options)\n print(f\"Auth token: {token_data}\")\n \n # Make a policy decision\n policy_input = PolicyInput(\n did=\"did:web:agent.example.com\",\n token=token_data[\"access_token\"],\n action=\"query\",\n resource=\"db://finance/tx\"\n )\n \n decision = await client.policy_decision(policy_input)\n print(f\"Policy decision: {decision.allow}\")\n\n# Run the async function\nasyncio.run(main())\n```\n\n## API Reference\n\n### IronBookClient\n\nThe main client class for interacting with Iron Book APIs.\n\n#### Constructor\n\n```python\nIronBookClient(api_key: str, base_url: str = \"https://dev.identitymachines.com\")\n```\n\n**Parameters:**\n- `api_key` (str): Your Iron Book API key\n- `base_url` (str, optional): Base URL for the API. Defaults to development environment.\n\n#### Methods\n\n##### register_agent(opts: RegisterAgentOptions) -> str\n\nRegisters a new agent and returns a Verifiable Credential.\n\n```python\nvc = await client.register_agent(RegisterAgentOptions(\n agent_name=\"my-agent\",\n capabilities=[\"query\", \"read\"],\n developer_did=\"did:web:example.com\" # Optional\n))\n```\n\n##### get_auth_token(opts: GetAuthTokenOptions) -> Dict[str, Any]\n\nGets an authentication token for an agent.\n\n```python\ntoken_data = await client.get_auth_token(GetAuthTokenOptions(\n agent_did=\"did:web:agent.example.com\",\n vc=vc,\n audience=\"https://api.identitymachines.com\",\n developer_did=\"did:web:example.com\" # Optional\n))\n```\n\n##### policy_decision(opts: PolicyInput) -> PolicyDecision\n\nGets a policy decision for an agent action.\n\n```python\ndecision = await client.policy_decision(PolicyInput(\n did=\"did:web:agent.example.com\",\n token=\"jwt-token\",\n action=\"query\",\n resource=\"db://finance/tx\",\n context={\"amount\": 1000, \"ticker\": \"AAPL\"}\n))\n```\n\n## Data Types\n\n### RegisterAgentOptions\n\nOptions for registering a new agent.\n\n```python\n@dataclass\nclass RegisterAgentOptions:\n agent_name: str # Name of the agent\n capabilities: List[str] # List of agent capabilities\n developer_did: Optional[str] # Developer's DID (optional)\n```\n\n### GetAuthTokenOptions\n\nOptions for getting an authentication token.\n\n```python\n@dataclass\nclass GetAuthTokenOptions:\n agent_did: str # Agent's DID\n vc: str # Verifiable Credential\n audience: str # Token audience (e.g., API endpoint)\n developer_did: Optional[str] # Developer's DID (optional)\n```\n\n### PolicyInput\n\nInput parameters for policy decision.\n\n```python\n@dataclass\nclass PolicyInput:\n did: str # Agent DID (subject)\n token: str # Short-lived access token (JWT)\n action: str # Action (e.g., \"query\")\n resource: str # Resource (e.g., \"db://finance/tx\")\n context: Optional[Dict[str, Any]] # Optional context (amount, ticker, etc.)\n```\n\n### PolicyDecision\n\nResult of a policy decision evaluation.\n\n```python\n@dataclass\nclass PolicyDecision:\n allow: bool # Whether the action is allowed\n evaluation: Optional[List[Any]] # Policy evaluation details\n reason: Optional[str] # Reason for the decision\n```\n\n### PolicyDecisionResult\n\nEnumeration for policy decision results.\n\n```python\nclass PolicyDecisionResult(str, Enum):\n ALLOW = \"allow\"\n DENY = \"deny\"\n```\n\n### UploadPolicyOptions\n\nOptions for uploading a policy.\n\n```python\n@dataclass\nclass UploadPolicyOptions:\n agent_did: str # Agent's DID\n config_type: str # Configuration type\n policy_content: str # Policy content\n metadata: Any # Policy metadata\n developer_did: Optional[str] # Developer's DID (optional)\n```\n\n## Advanced Usage\n\n### Error Handling\n\n```python\nimport asyncio\nfrom ironbook_sdk import IronBookClient\n\nasync def safe_agent_operation():\n client = IronBookClient(api_key=\"your-api-key\")\n \n try:\n # Your operations here\n vc = await client.register_agent(...)\n return vc\n except Exception as e:\n print(f\"Error: {e}\")\n return None\n\nasyncio.run(safe_agent_operation())\n```\n\n### Custom Base URL\n\n```python\n# Use production environment\nclient = IronBookClient(\n api_key=\"your-api-key\",\n base_url=\"https://api.identitymachines.com\"\n)\n```\n\n### Policy Decision with Context\n\n```python\n# Make a policy decision with rich context\ndecision = await client.policy_decision(PolicyInput(\n did=\"did:web:agent.example.com\",\n token=\"jwt-token\",\n action=\"transfer\",\n resource=\"bank://account/123\",\n context={\n \"amount\": 5000,\n \"currency\": \"USD\",\n \"recipient\": \"alice@example.com\",\n \"timestamp\": \"2024-01-15T10:30:00Z\"\n }\n))\n\nif decision.allow:\n print(\"Transfer approved\")\n if decision.reason:\n print(f\"Reason: {decision.reason}\")\nelse:\n print(\"Transfer denied\")\n if decision.reason:\n print(f\"Reason: {decision.reason}\")\n```\n\n### Upload Policy\n\n```python\n# Upload a new access control policy\nupload_options = UploadPolicyOptions(\n agent_did=\"did:web:agent.example.com\",\n config_type=\"opa\",\n policy_content=\"package policy\\nallow { input.action == \\\"read\\\" }\",\n metadata={\"version\": \"1.0\", \"description\": \"Read-only policy\"},\n developer_did=\"did:web:example.com\" # Optional\n)\n\nresult = await client.upload_policy(upload_options)\nprint(f\"Policy uploaded: {result}\")\n```\n\n## Development\n\n### Setting up the development environment\n\n```bash\n# Clone the repository\ngit clone https://github.com/your-org/ironbook-sdk-python.git\ncd ironbook-sdk-python\n\n# Install development dependencies\npip install -e .\npip install pytest pytest-asyncio\n\n# Run tests\npytest\n```\n\n### Building and publishing\n\n```bash\n# Install build tools\npip install build twine\n\n# Build the package\npython -m build\n\n# Test upload to TestPyPI\ntwine upload --repository testpypi dist/*\n\n# Upload to PyPI (when ready)\ntwine upload dist/*\n```\n\n## Support\n\n- **Documentation**: [https://docs.identitymachines.com](https://docs.identitymachines.com)\n- **Issues**: [GitHub Issues](https://github.com/your-org/ironbook-sdk-python/issues)\n- **Email**: devops@identitymachines.com\n\n## Changelog\n\n### 0.1.0\n- Initial release\n- Agent registration functionality\n- Authentication token generation\n- Policy decision evaluation\n- Policy upload functionality\n- Async/await support\n- Comprehensive type hints\n- Context manager support for client lifecycle management\n- Convenience functions for simplified usage\n",
"bugtrack_url": null,
"license": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n \n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n \n 1. Definitions.\n \n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n \n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n \n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n \n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n \n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n \n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n \n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n \n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n \n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n \n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n \n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n \n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n \n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n \n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n \n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n \n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n \n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n \n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n \n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n \n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n \n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n \n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n \n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n \n END OF TERMS AND CONDITIONS\n \n APPENDIX: How to apply the Apache License to your work.\n \n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n \n Copyright [yyyy] [name of copyright owner]\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n ",
"summary": "Python SDK for Iron Book by Identity Machines",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://docs.identitymachines.com",
"Homepage": "https://www.identitymachines.com",
"Repository": "https://github.com/identitymachines/ironbook-sdk-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "df4dd15560a6c5f9db70aa8b5b7203af88fbfecdc443895c8a3f9c4881234690",
"md5": "ab5eef870c7be648bb50922514800908",
"sha256": "e4a77e667ff1a01606b46d5b5e5a40316dd092290565ec0779f80d16d6101008"
},
"downloads": -1,
"filename": "ironbook_sdk-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ab5eef870c7be648bb50922514800908",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11850,
"upload_time": "2025-07-23T15:26:29",
"upload_time_iso_8601": "2025-07-23T15:26:29.698275Z",
"url": "https://files.pythonhosted.org/packages/df/4d/d15560a6c5f9db70aa8b5b7203af88fbfecdc443895c8a3f9c4881234690/ironbook_sdk-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "aef28076ad5c697f8fa3e8e840cea2be7ca165e6d774c2d1c7e0a4f7519faf3e",
"md5": "87d883cb2a1eb9fed89a18ed81396551",
"sha256": "22e93753bf1d8d31cca2d24b5647de73c19e6b04d5e502a2cf55d16a1544fd54"
},
"downloads": -1,
"filename": "ironbook_sdk-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "87d883cb2a1eb9fed89a18ed81396551",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 14109,
"upload_time": "2025-07-23T15:26:30",
"upload_time_iso_8601": "2025-07-23T15:26:30.944939Z",
"url": "https://files.pythonhosted.org/packages/ae/f2/8076ad5c697f8fa3e8e840cea2be7ca165e6d774c2d1c7e0a4f7519faf3e/ironbook_sdk-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-23 15:26:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "identitymachines",
"github_project": "ironbook-sdk-python",
"github_not_found": true,
"lcname": "ironbook-sdk"
}
