Skip to main content

SSI Empoorio ID - Complete Self-Sovereign Identity SDK for Python

Project description

SSI Empoorio ID Python SDK

Complete Self-Sovereign Identity SDK for Python applications

PyPI version License: MIT Python 3.8+

What is SSI Empoorio ID?

SSI Empoorio ID is a comprehensive Self-Sovereign Identity platform that enables secure, privacy-preserving digital identity management. This Python SDK provides complete access to verifiable credentials, biometric authentication, and decentralized identity operations.

Key Features

  • 🔐 Verifiable Credentials: Issue, verify, and revoke digital credentials
  • 👤 Decentralized Identifiers: Create and manage DIDs (Decentralized Identifiers)
  • 🖐️ Biometric Authentication: WebAuthn/FIDO2 support for secure authentication
  • 🔒 Quantum-Resistant: Post-quantum cryptography integration
  • 🎭 Zero-Knowledge Proofs: Privacy-preserving selective disclosure
  • ⚡ High Performance: Async support and optimized operations
  • 🛠️ CLI Tools: Command-line interface for development and operations
  • 📊 Dashboard: Interactive terminal dashboard for SSI management

Installation

pip install ssi-empoorio-id

Optional Dependencies

# For async operations
pip install ssi-empoorio-id[async]

# For terminal dashboard
pip install ssi-empoorio-id[dashboard]

# For development
pip install ssi-empoorio-id[dev]

# All features
pip install ssi-empoorio-id[all]

Quick Start

Basic Usage

from ssi_empoorio_id import SSIEmporioSDK

# Initialize SDK
ssi = SSIEmporioSDK(
    issuer_url='https://api.empoorio.id',
    verifier_url='https://verify.empoorio.id'
)

# Create a DID
did = ssi.create_test_did('emp')
print(f"Created DID: {did}")

# Issue a verifiable credential
subject = {
    'id': did,
    'name': 'John Doe',
    'email': 'john@example.com',
    'age': 30
}

vc = ssi.issue_credential(
    subject=subject,
    credential_type=['VerifiableCredential', 'IdentityCredential'],
    options={'quantum_resistant': True}
)

print(f"Issued VC: {vc.id}")

# Verify the credential
verification = ssi.verify_credential(vc)
print(f"Verification: {'✅ Valid' if verification.verified else '❌ Invalid'}")

CLI Usage

# Issue verifiable credential
ssi-python vc issue subject.json -t VerifiableCredential,IdentityCredential -q

# Verify credential
ssi-python vc verify credential.json

# Create DID
ssi-python did create -p emp

# Launch interactive dashboard
ssi-python dashboard

Use Cases

Digital Identity Verification

# Bank KYC verification
kyc_vc = ssi.issue_credential(
    subject=user_data,
    credential_type=['VerifiableCredential', 'KYC'],
    options={'selective_disclosure': True}
)

Access Control

# Secure building access
access_vc = ssi.issue_credential(
    subject={'employee_id': '12345', 'clearance_level': 'high'},
    credential_type=['AccessCredential'],
    options={'biometric_required': True}
)

Academic Credentials

# University diploma
diploma_vc = ssi.issue_credential(
    subject=student_data,
    credential_type=['VerifiableCredential', 'UniversityDegree'],
    options={'zkp_enabled': True}
)

API Overview

Core Classes

  • SSIEmporioSDK: Main synchronous SDK client
  • AsyncSSIEmporioSDK: Asynchronous version for high-performance apps
  • VerifiableCredential: VC data structure
  • VerificationResult: Credential verification results

Main Operations

  • Issuer Operations: Issue, revoke, status management
  • Verifier Operations: Verify credentials and presentations
  • DID Operations: Create, validate, resolve DIDs
  • Biometric Operations: WebAuthn integration
  • Status Registry: Credential lifecycle management

Development

Setting up Development Environment

git clone https://github.com/empoorio/ssi-empoorio-id.git
cd ssi-empoorio-id/sdks/python

# Install development dependencies
pip install -e .[dev]

# Run tests
pytest

# Type checking
mypy ssi_empoorio_id/

# Code formatting
black ssi_empoorio_id/
isort ssi_empoorio_id/

Running Tests

# All tests
pytest

# With coverage
pytest --cov=ssi_empoorio_id --cov-report=html

# Specific test file
pytest tests/test_vc.py -v

Documentation

  • 📚 Full Documentation: https://docs.empoorio.id/python-sdk
  • 🔧 API Reference: Complete method documentation
  • 📖 Integration Guides: Framework-specific guides
  • 🎯 Examples: Code samples and tutorials

Security Features

  • Quantum-Resistant Signatures: Dilithium, Falcon algorithms
  • Zero-Knowledge Proofs: Privacy-preserving verification
  • Selective Disclosure: Share only necessary information
  • Biometric Authentication: WebAuthn/FIDO2 support
  • Secure Communication: TLS 1.3, certificate pinning

Supported Platforms

  • Python: 3.8, 3.9, 3.10, 3.11
  • Operating Systems: Linux, macOS, Windows
  • Frameworks: Django, FastAPI, Flask, async apps

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

Copyright (c) 2024 Empoorio Inc.

Licensed under the MIT License - see LICENSE file for details.

Support


🚀 Built by Empoorio Inc. - Empowering the future of digital identity.

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

ssi_empoorio_id-1.0.1.tar.gz (32.4 kB view details)

Uploaded Source

Built Distribution

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

ssi_empoorio_id-1.0.1-py3-none-any.whl (34.6 kB view details)

Uploaded Python 3

File details

Details for the file ssi_empoorio_id-1.0.1.tar.gz.

File metadata

  • Download URL: ssi_empoorio_id-1.0.1.tar.gz
  • Upload date:
  • Size: 32.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for ssi_empoorio_id-1.0.1.tar.gz
Algorithm Hash digest
SHA256 cdbe7c9949014aa41dfc93296af6e28fd758e84dfd3b3c9894c07cc387e37fc4
MD5 b347cde0ecc0f06819a56de15e9caed4
BLAKE2b-256 038d9ea60ca5dae61532a8857106805dc65803f5734f8bd184368243405a9179

See more details on using hashes here.

File details

Details for the file ssi_empoorio_id-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ssi_empoorio_id-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 159661fb62414df204454501c338ed0cd18ff224e1e7d55e6d5703659c7dd724
MD5 4b8abf9229b85f20931d2db4184be5a7
BLAKE2b-256 650098fa9759f995e20c1546c25680034d2a4f722dde6aa6407d7c1f51774081

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