qanuni-sdk 0.2.0__tar.gz

qanuni_sdk-0.2.0/.env.example

@@ -0,0 +1,10 @@
+OPENAI_API_KEY=sk-your-openai-key
+QANUNI_MODEL=gpt-5.5
+QANUNI_LANGUAGE=ar
+QANUNI_JURISDICTION=SA
+QANUNI_TIMEOUT=90
+QANUNI_MAX_RETRIES=2
+QANUNI_MAX_OUTPUT_TOKENS=2500
+QANUNI_REASONING_EFFORT=medium
+QANUNI_VERBOSITY=medium
+QANUNI_LOG_LEVEL=WARNING

qanuni_sdk-0.2.0/.gitignore

@@ -0,0 +1,12 @@
+.env
+.env.local
+.qanuni.yaml
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+__pycache__/
+*.pyc
+dist/
+build/
+htmlcov/
+.coverage

qanuni_sdk-0.2.0/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to `qanuni-sdk` should be documented in this file.
+
+## 0.2.0 - 2026-05-24
+
+Free-edition release.
+
+Highlights:
+
+- Removed activation and licensing flows from the published distribution
+- Made the shipped toolset and async execution fully free
+- Rebuilt examples and user docs around a zero-license journey
+- Split this distribution into its own publishable `free_edition` folder
+- Simplified package metadata and dependencies for the free build
+
+## 0.1.0 - 2026-05-24
+
+Initial public alpha release.
+
+Highlights:
+
+- Arabic-first Saudi legal SDK foundation
+- Implemented labor, contracts, compliance, drafting, and policy namespaces
+- Signed-license validation and entitlement enforcement
+- Bundled runnable examples and local owner verification command
+- Trusted-publishing-ready GitHub workflow for TestPyPI and PyPI

qanuni_sdk-0.2.0/FullReadme.md

@@ -0,0 +1,427 @@
+# Full Qanuni Free Edition Walkthrough
+
+This file is the complete journey for a first-time user of the **free Qanuni SDK distribution**.
+
+In this edition:
+
+- all shipped tools are free
+- there is no activation flow
+- there is no `license_token`
+- there is no `client.license`
+- async methods are also available
+
+The only external credential you may need is your own `OPENAI_API_KEY` for prompt-backed tools.
+Do not place the API key directly inside notebook cells. Prefer `.env` or environment variables.
+
+## 1. Install the Package
+
+If you are using the already published package:
+
+```bash
+pip install qanuni-sdk
+```
+
+If you are validating this repository locally before publishing, move into
+`free_edition` and install the local source instead of pulling the older PyPI release:
+
+```bash
+cd free_edition
+python -m pip install -e .
+```
+
+Inside Jupyter, prefer:
+
+```python
+%pip install -e .
+```
+
+Import name:
+
+```python
+from qanuni import LegalClient
+```
+
+Package name and import name are different on purpose:
+
+- package on PyPI: `qanuni-sdk`
+- import in Python: `qanuni`
+
+## 2. Optional `.env` Setup
+
+Create a local `.env`:
+
+```bash
+OPENAI_API_KEY=sk-...
+QANUNI_MODEL=gpt-5.5
+QANUNI_LANGUAGE=ar
+QANUNI_JURISDICTION=SA
+QANUNI_TIMEOUT=90
+QANUNI_MAX_RETRIES=2
+QANUNI_MAX_OUTPUT_TOKENS=2500
+QANUNI_REASONING_EFFORT=medium
+QANUNI_VERBOSITY=medium
+```
+
+You can also pass everything directly in code.
+
+## 3. Create Your First Client
+
+If you only want deterministic labor tools:
+
+```python
+from qanuni import LegalClient
+
+client = LegalClient()
+```
+
+If you want prompt-backed tools:
+
+```python
+from qanuni import LegalClient
+
+client = LegalClient(api_key="sk-...")
+```
+
+## 4. Inspect the Tool Catalog
+
+```python
+from qanuni import LegalClient
+
+client = LegalClient()
+
+for tool in client.list_tools():
+    print(tool.tool_id, tool.tier, tool.implementation)
+```
+
+You can also inspect availability:
+
+```python
+for tool in client.list_tool_access():
+    print(tool.tool_id, tool.available, tool.reason)
+```
+
+In this free edition, all shipped tools should be available.
+
+## 5. Use Deterministic Tools Without OpenAI
+
+### End of service
+
+```python
+from qanuni import LegalClient
+
+client = LegalClient()
+
+result = client.labor.end_of_service(
+    monthly_salary=12000,
+    years_of_service=7.5,
+    termination_reason="resignation",
+    contract_type="indefinite",
+)
+
+print(result.total_amount)
+print(result.calculation_breakdown)
+print(result.legal_explanation)
+print(result.additional_entitlements)
+```
+
+### Probation check
+
+```python
+result = client.labor.probation_check(
+    probation_days=120,
+    extension_in_writing=True,
+)
+
+print(result.is_legal)
+print(result.max_allowed_days)
+print(result.violations)
+```
+
+## 6. Use Prompt-Backed Tools With OpenAI
+
+### Improve drafting
+
+```python
+from qanuni import LegalClient
+
+client = LegalClient(api_key="sk-...")
+
+result = client.drafting.improve(
+    original_text="يدفع الطرف الأول عند الإنجاز.",
+    improvement_goals=["precision", "clarity", "formality"],
+    context="service agreement",
+)
+
+print(result.improved_text)
+print(result.changes)
+```
+
+### Summarize a legal document
+
+```python
+result = client.drafting.summarize(
+    document_text="""
+    يتعهد الطرف الأول بتقديم الخدمات التقنية،
+    ويلتزم الطرف الثاني بسداد المقابل وفق الفواتير الصادرة،
+    ويجوز إنهاء الاتفاق عند الإخلال الجسيم.
+    """,
+    summary_length="executive",
+)
+
+print(result.summary)
+print(result.key_obligations)
+print(result.risk_highlights)
+```
+
+### Simplify legal Arabic
+
+```python
+result = client.drafting.simplify(
+    legal_text="يلتزم الموظف بعدم منافسة صاحب العمل خلال المدة المنصوص عليها تعاقديًا."
+)
+
+print(result.simplified_text)
+```
+
+## 7. Contract and Commercial Tools
+
+### Contract gap analysis
+
+```python
+result = client.contracts.gap_analysis(
+    contract_text="""
+    يلتزم الطرف الثاني بتنفيذ الأعمال،
+    ويتم السداد لاحقًا وفق ما يراه الطرف الأول مناسبًا،
+    ويجوز إنهاء العقد عند الحاجة.
+    """,
+    contract_type="service_agreement",
+)
+
+print(result.summary)
+print(result.gaps)
+print(result.missing_mandatory_clauses)
+```
+
+### Generate NDA
+
+```python
+result = client.contracts.generate_nda(
+    nda_type="mutual",
+    disclosing_party="شركة ألف",
+    receiving_party="شركة باء",
+    purpose="دراسة شراكة تشغيلية",
+    confidentiality_period_years=3,
+)
+
+print(result.nda_text)
+```
+
+### Generate MOU
+
+```python
+result = client.contracts.generate_mou(
+    party_a="شركة ألف",
+    party_b="شركة باء",
+    objectives=["تطوير منصة قانونية مشتركة"],
+    responsibilities=["تبادل المتطلبات", "تجهيز خطة تنفيذ أولية"],
+    duration_months=6,
+    binding_sections=["السرية", "القانون الحاكم"],
+)
+
+print(result.mou_text)
+```
+
+## 8. Compliance and Policy Tools
+
+### Privacy policy
+
+```python
+result = client.compliance.generate_privacy_policy(
+    company_name="شركة تقنية سعودية",
+    service_type="منصة SaaS",
+    data_collected=["الاسم", "الهاتف", "البريد الإلكتروني", "بيانات الاستخدام"],
+    data_purposes=["تشغيل الخدمة", "التحقق", "الدعم", "الأمن"],
+    third_party_sharing=False,
+    international_transfers=False,
+)
+
+print(result.policy_text)
+print(result.pdpl_compliance_score)
+```
+
+### Demand letter
+
+```python
+result = client.compliance.demand_letter(
+    sender_name="شركة ألف",
+    recipient_name="شركة باء",
+    claim_type="مستحقات تعاقدية",
+    claim_amount=85000,
+    incident_description="تأخر في سداد مستحقات عقد خدمات تقنية.",
+    deadline_days=7,
+    threat_of_action="سيتم اتخاذ الإجراءات القانونية المناسبة عند عدم السداد.",
+)
+
+print(result.letter_text)
+```
+
+### HR policy
+
+```python
+result = client.policies.generate_hr_policy(
+    policy_type="الغياب والانضباط",
+    company_name="شركة تجريبية",
+    industry="خدمات تقنية",
+    employee_count=45,
+    custom_requirements=["اعتماد التدرج التأديبي", "تحديد آلية التوثيق"],
+)
+
+print(result.policy_text)
+```
+
+### Job description
+
+```python
+result = client.policies.job_description(
+    job_title="أخصائي التزام",
+    department="الشؤون القانونية",
+    required_experience_years=2,
+    required_education="بكالوريوس قانون",
+    key_responsibilities=["إعداد التقارير", "متابعة السياسات", "مراجعة المخاطر"],
+    required_skills=["التحليل", "صياغة السياسات", "المراجعة القانونية"],
+    saudization_preferred=True,
+)
+
+print(result.job_description_text)
+```
+
+## 9. Async Is Free in This Edition
+
+```python
+import asyncio
+
+from qanuni import LegalClient
+
+client = LegalClient(api_key="sk-...")
+
+
+async def main() -> None:
+    result = await client.drafting.aimprove(
+        original_text="يدفع الطرف الأول عند الإنجاز.",
+        improvement_goals=["precision", "clarity"],
+        context="service agreement",
+    )
+    print(result.improved_text)
+
+
+asyncio.run(main())
+```
+
+## 10. Local Mocked Exploration Without OpenAI
+
+The package ships `examples.py` as a mini lab:
+
+```bash
+qanuni-examples --list
+qanuni-examples --category mocked_local
+qanuni-examples labor_end_of_service
+```
+
+This is useful when you want to:
+
+- explore outputs
+- verify installation
+- write docs
+- test the package without API cost
+
+## 11. Common Faulty Scenarios
+
+### Missing OpenAI key
+
+```python
+from qanuni import LegalClient
+
+client = LegalClient()
+
+client.drafting.improve(
+    original_text="هذا نص يحتاج تحسينًا.",
+    improvement_goals=["clarity"],
+    context="contract",
+)
+```
+
+Expected result:
+
+- provider configuration error because no `OPENAI_API_KEY` was configured
+
+### Mixed input styles
+
+```python
+client.drafting.improve(
+    {"original_text": "نص أولي"},
+    original_text="نص آخر",
+    improvement_goals=["clarity"],
+    context="memo",
+)
+```
+
+Expected result:
+
+- `QANUNI_VALIDATION_INPUT_CONFLICT`
+
+### Missing contract source
+
+```python
+client.contracts.gap_analysis(contract_type="service_agreement")
+```
+
+Expected result:
+
+- `QANUNI_VALIDATION_DOCUMENT_SOURCE_MISSING`
+
+## 12. YAML Configuration
+
+You can load the client from `.qanuni.yaml`:
+
+```yaml
+openai:
+  api_key: "sk-..."
+  model: "gpt-5.5"
+
+locale:
+  language: "ar"
+  jurisdiction: "SA"
+
+performance:
+  timeout: 90
+  max_retries: 2
+
+tools:
+  drafting.improve:
+    max_output_tokens: 1800
+```
+
+Then:
+
+```python
+from qanuni import LegalClient
+
+client = LegalClient.from_config(".qanuni.yaml")
+```
+
+## 13. Full First Session Suggestion
+
+If you are new to the SDK, use this order:
+
+1. Install `qanuni-sdk` if you are testing the published package.
+2. If you are still inside the repository before release, run `%pip install -e .` from `free_edition`.
+3. Run `qanuni-examples --list`.
+4. Run `qanuni-examples --category mocked_local`.
+5. Add your `OPENAI_API_KEY` through `.env`.
+6. Try `drafting.improve`.
+7. Try `contracts.gap_analysis`.
+8. Integrate the returned structured outputs into your app.
+
+## 14. Maintainer Note
+
+This free distribution is designed to keep the same PyPI project name `qanuni-sdk`, but it must be published as a **new version**, not by re-uploading the old one. See [docs/guides/README_PUBLISHING.md](docs/guides/README_PUBLISHING.md).

qanuni_sdk-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 BandAI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

qanuni_sdk-0.2.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: qanuni-sdk
+Version: 0.2.0
+Summary: Arabic-first free legal intelligence SDK for Saudi-focused legal workflows.
+Author: BandAI
+License-Expression: MIT
+License-File: LICENSE
+Keywords: arabic,compliance,legal,openai,saudi,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: jinja2>=3.1.4
+Requires-Dist: openai<3.0.0,>=2.0.0
+Requires-Dist: pydantic-settings>=2.3.4
+Requires-Dist: pydantic>=2.8.2
+Requires-Dist: pyyaml>=6.0.2
+Provides-Extra: cli
+Requires-Dist: rich>=13.7.1; extra == 'cli'
+Requires-Dist: typer>=0.12.3; extra == 'cli'
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2.post1; extra == 'dev'
+Requires-Dist: mypy>=1.11.1; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.3.2; extra == 'dev'
+Requires-Dist: ruff>=0.6.1; extra == 'dev'
+Requires-Dist: twine>=6.1.0; extra == 'dev'
+Provides-Extra: pdf
+Requires-Dist: pdfplumber>=0.11.4; extra == 'pdf'
+Provides-Extra: release
+Requires-Dist: build>=1.2.2.post1; extra == 'release'
+Requires-Dist: twine>=6.1.0; extra == 'release'
+Description-Content-Type: text/markdown
+
+# Qanuni SDK
+
+Qanuni is an Arabic-first Python SDK for Saudi legal workflows.
+
+This build is the **fully free distribution**:
+
+- no activation
+- no license token
+- no premium gate
+- all shipped tools are available immediately
+
+Users bring their own OpenAI API key for prompt-backed tools. Deterministic tools such as Saudi labor calculations work without OpenAI.
+
+## Install
+
+```bash
+pip install qanuni-sdk
+```
+
+## Quickstart
+
+```python
+from qanuni import LegalClient
+
+client = LegalClient(api_key="sk-...")
+
+benefit = client.labor.end_of_service(
+    monthly_salary=12000,
+    years_of_service=7.5,
+    termination_reason="resignation",
+    contract_type="indefinite",
+)
+
+print(benefit.total_amount)
+```
+
+```python
+from qanuni import LegalClient
+
+client = LegalClient(api_key="sk-...")
+
+result = client.contracts.gap_analysis(
+    contract_text="يلتزم الطرف الثاني بتنفيذ الأعمال، ويتم السداد لاحقًا."
+)
+
+print(result.summary)
+```
+
+## Included Tools
+
+- `labor.end_of_service`
+- `labor.probation_check`
+- `contracts.gap_analysis`
+- `contracts.generate_nda`
+- `contracts.generate_mou`
+- `drafting.improve`
+- `drafting.summarize`
+- `drafting.simplify`
+- `compliance.generate_privacy_policy`
+- `compliance.demand_letter`
+- `policies.generate_hr_policy`
+- `policies.job_description`
+
+## Examples Command
+
+```bash
+qanuni-examples --list
+```
+
+## Default Behavior
+
+- Arabic-first prompts and outputs
+- Saudi-oriented legal framing
+- structured Pydantic outputs
+- async methods available in this free build