hjs-client 0.1.0

Python client for HJS API - A Protocol for Structural Traceability

中文 | English

HJS Python Client

Python client for HJS API — a responsibility tracing service.

📦 Installation

From PyPI (when published)

pip install hjs-client

From GitHub (current)

pip install git+https://github.com/schchit/hjs-api.git#subdirectory=client-py

From local source

cd /workspaces/hjs-api/client-py
pip install -e .

🚀 Quick Start

Basic Example

from hjs_client import HJSClient

# Create client
client = HJSClient()

# Record a judgment
result = client.record_judgment(
    entity="[e-mail]",
    action="loan_approved",
    scope={"amount": 100000}
)
print("✅ Recorded:", result)

# Retrieve it
judgment = client.get_judgment(result['id'])
print("✅ Retrieved:", judgment)

Using Context Manager

from hjs_client import HJSClient

with HJSClient() as client:
    result = client.record_judgment("[e-mail]", "test_action")
    print("✅ Recorded:", result)

Error Handling

from hjs_client import HJSClient
import requests

client = HJSClient()

try:
    result = client.record_judgment("[e-mail]", "test_action")
    print("✅ Success:", result)
except ValueError as e:
    print("❌ Validation error:", e)
except requests.RequestException as e:
    print("❌ API error:", e)

📚 API Reference

HJSClient(base_url, timeout)

Create a new client instance.

Parameter	Type	Default	Description
base_url	str	"https://hjs-api.onrender.com"	API base URL
timeout	int	30	Request timeout in seconds

record_judgment(entity, action, scope)

Record a judgment.

Parameter	Type	Required	Description
entity	str	✅	Who made the judgment
action	str	✅	What action was judged
scope	dict	❌	Optional additional context

Returns: { id, status, timestamp }

Raises:

• ValueError: If required parameters are missing
• requests.RequestException: If API request fails

get_judgment(id)

Retrieve a judgment by ID.

Parameter	Type	Required	Description
id	str	✅	Judgment ID from record_judgment

Returns: Complete judgment record

Raises:

• ValueError: If ID is missing or not found
• requests.RequestException: If API request fails

🧪 Testing

cd /workspaces/hjs-api/client-py
python -c "
from hjs_client import HJSClient
client = HJSClient()
result = client.record_judgment('[e-mail]', 'test_action')
print('✅ Recorded:', result)
judgment = client.get_judgment(result['id'])
print('✅ Retrieved:', judgment)
"

Expected output:

✅ Recorded: {'id': 'jgd_...', 'status': 'recorded', 'timestamp': '...'}
✅ Retrieved: {'id': 'jgd_...', 'entity': '[e-mail]', 'action': 'test_action', ...}

📄 License

MIT © HJS Contributors

🤝 Contributing

Contributions are welcome! Please:

• Open an Issue for bugs or suggestions
• Submit Pull Requests for improvements

---