quran-foundation-api 0.1.0__tar.gz

quran_foundation_api-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - run: python -m pip install --upgrade pip
+      - run: python -m pip install -e ".[dev]"
+      - run: ruff check .
+      - run: pytest
+      - run: python -m build
+      - run: twine check dist/*

quran_foundation_api-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,63 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      target:
+        description: Package index to publish
+        required: true
+        type: choice
+        default: testpypi
+        options:
+          - testpypi
+          - pypi
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: pip
+      - run: python -m pip install --upgrade pip
+      - run: python -m pip install build twine
+      - run: python -m build
+      - run: twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+
+  publish-testpypi:
+    needs: build
+    if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && inputs.target == 'testpypi')
+    runs-on: ubuntu-latest
+    environment: testpypi
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    needs: build
+    if: github.event_name == 'workflow_dispatch' && inputs.target == 'pypi'
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1

quran_foundation_api-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/
+.DS_Store

quran_foundation_api-0.1.0/AGENTS.md

@@ -0,0 +1,8 @@
+# Agent Instructions
+
+Keep the Python SDK small, explicit, and server-safe.
+
+- Do not expose OAuth client secrets or tokens in examples intended for browsers.
+- Prefer stable sync APIs before adding async variants.
+- Keep public package docs accurate for PyPI users.
+- Verify with ruff, pytest, build, and twine check before release.

quran_foundation_api-0.1.0/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.1.0
+
+- Initial Python SDK with sync client and OAuth2 helpers.
+- Added explicit helpers for core Content, Search, and signed-in User API workflows.
+- Added service request helpers for Content, Search, and User endpoints that do not yet have dedicated methods.

quran_foundation_api-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Quran Foundation
+
+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.

quran_foundation_api-0.1.0/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: quran-foundation-api
+Version: 0.1.0
+Summary: Official Python SDK for Quran Foundation APIs.
+Project-URL: Homepage, https://api-docs.quran.foundation/docs/sdk/python/
+Project-URL: Documentation, https://api-docs.quran.foundation/docs/sdk/python/
+Project-URL: Repository, https://github.com/quran/api-python
+Project-URL: Issues, https://github.com/quran/api-python/issues
+Author-email: Quran Foundation <developers@quran.foundation>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,oauth2,quran,quran-foundation,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx<1,>=0.27
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.8; extra == 'dev'
+Requires-Dist: twine>=6.0; extra == 'dev'
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.115; extra == 'fastapi'
+Requires-Dist: uvicorn>=0.30; extra == 'fastapi'
+Description-Content-Type: text/markdown
+
+# quran-foundation-api
+
+Official Python SDK for Quran Foundation APIs.
+
+```bash
+pip install quran-foundation-api
+```
+
+```python
+from quran_foundation import QuranClient
+
+client = QuranClient(client_id="YOUR_CLIENT_ID", access_token="ACCESS_TOKEN")
+chapters = client.list_chapters()
+print(chapters)
+```
+
+## Content and search
+
+```python
+from quran_foundation import QuranClient
+
+client = QuranClient(client_id="YOUR_CLIENT_ID", access_token="ACCESS_TOKEN")
+
+chapter = client.get_chapter(1)
+verses = client.get_verses_by_range("1:1", "1:7", translations="131")
+translations = client.list_translations()
+results = client.search("mercy", mode="advanced", params={"size": 10})
+```
+
+For endpoints that do not yet have a dedicated helper, use the service request helpers:
+
+```python
+client.content_request("/verses/by_page/1", params={"translations": "131"})
+client.search_request("/api/v1/search", params={"query": "mercy", "mode": "quick"})
+client.user_request("/bookmarks", params={"page": 1})
+```
+
+## User APIs
+
+Use signed-in User API helpers with a user access token. Keep the token server-side.
+
+```python
+profile = client.get_profile()
+bookmarks = client.list_bookmarks()
+client.create_bookmark({"verse_key": "2:255", "mushaf_id": 1})
+client.update_preference({"key": "theme", "value": "dark"})
+```
+
+## OAuth2 helpers
+
+Use OAuth helpers on the server side. Never expose `client_secret`, access tokens, or refresh tokens to browser code.
+
+```python
+from quran_foundation.oauth import build_authorization_url, create_pkce_pair, exchange_code
+
+verifier, challenge = create_pkce_pair()
+authorize_url = build_authorization_url(
+    client_id="YOUR_CLIENT_ID",
+    redirect_uri="https://your-app.com/callback",
+    scope="openid offline_access user bookmark",
+    state="random-state",
+    code_challenge=challenge,
+)
+
+tokens = exchange_code(
+    client_id="YOUR_CLIENT_ID",
+    client_secret="YOUR_CLIENT_SECRET",
+    code="CODE_FROM_CALLBACK",
+    code_verifier=verifier,
+    redirect_uri="https://your-app.com/callback",
+)
+```
+
+## Development
+
+```bash
+python -m pip install -e ".[dev]"
+ruff check .
+pytest
+python -m build
+twine check dist/*
+```

quran_foundation_api-0.1.0/README.md

@@ -0,0 +1,82 @@
+# quran-foundation-api
+
+Official Python SDK for Quran Foundation APIs.
+
+```bash
+pip install quran-foundation-api
+```
+
+```python
+from quran_foundation import QuranClient
+
+client = QuranClient(client_id="YOUR_CLIENT_ID", access_token="ACCESS_TOKEN")
+chapters = client.list_chapters()
+print(chapters)
+```
+
+## Content and search
+
+```python
+from quran_foundation import QuranClient
+
+client = QuranClient(client_id="YOUR_CLIENT_ID", access_token="ACCESS_TOKEN")
+
+chapter = client.get_chapter(1)
+verses = client.get_verses_by_range("1:1", "1:7", translations="131")
+translations = client.list_translations()
+results = client.search("mercy", mode="advanced", params={"size": 10})
+```
+
+For endpoints that do not yet have a dedicated helper, use the service request helpers:
+
+```python
+client.content_request("/verses/by_page/1", params={"translations": "131"})
+client.search_request("/api/v1/search", params={"query": "mercy", "mode": "quick"})
+client.user_request("/bookmarks", params={"page": 1})
+```
+
+## User APIs
+
+Use signed-in User API helpers with a user access token. Keep the token server-side.
+
+```python
+profile = client.get_profile()
+bookmarks = client.list_bookmarks()
+client.create_bookmark({"verse_key": "2:255", "mushaf_id": 1})
+client.update_preference({"key": "theme", "value": "dark"})
+```
+
+## OAuth2 helpers
+
+Use OAuth helpers on the server side. Never expose `client_secret`, access tokens, or refresh tokens to browser code.
+
+```python
+from quran_foundation.oauth import build_authorization_url, create_pkce_pair, exchange_code
+
+verifier, challenge = create_pkce_pair()
+authorize_url = build_authorization_url(
+    client_id="YOUR_CLIENT_ID",
+    redirect_uri="https://your-app.com/callback",
+    scope="openid offline_access user bookmark",
+    state="random-state",
+    code_challenge=challenge,
+)
+
+tokens = exchange_code(
+    client_id="YOUR_CLIENT_ID",
+    client_secret="YOUR_CLIENT_SECRET",
+    code="CODE_FROM_CALLBACK",
+    code_verifier=verifier,
+    redirect_uri="https://your-app.com/callback",
+)
+```
+
+## Development
+
+```bash
+python -m pip install -e ".[dev]"
+ruff check .
+pytest
+python -m build
+twine check dist/*
+```

quran_foundation_api-0.1.0/examples/basic_usage.py

@@ -0,0 +1,5 @@
+from quran_foundation import QuranClient
+
+client = QuranClient(client_id="YOUR_CLIENT_ID", access_token="ACCESS_TOKEN")
+print(client.list_chapters())
+print(client.search("mercy"))

quran_foundation_api-0.1.0/examples/fastapi_callback.py

@@ -0,0 +1,26 @@
+from fastapi import FastAPI, HTTPException, Request
+
+from quran_foundation.oauth import exchange_code
+
+app = FastAPI()
+
+CLIENT_ID = "YOUR_CLIENT_ID"
+CLIENT_SECRET = "YOUR_CLIENT_SECRET"
+REDIRECT_URI = "http://localhost:8000/callback"
+
+
+@app.get("/callback")
+def callback(request: Request, code: str, state: str):
+    code_verifier = request.session.get("code_verifier") if hasattr(request, "session") else None
+    expected_state = request.session.get("state") if hasattr(request, "session") else None
+
+    if not code_verifier or state != expected_state:
+        raise HTTPException(status_code=400, detail="Invalid OAuth state")
+
+    return exchange_code(
+        client_id=CLIENT_ID,
+        client_secret=CLIENT_SECRET,
+        code=code,
+        code_verifier=code_verifier,
+        redirect_uri=REDIRECT_URI,
+    )

quran_foundation_api-0.1.0/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ["hatchling>=1.26"]
+build-backend = "hatchling.build"
+
+[project]
+name = "quran-foundation-api"
+version = "0.1.0"
+description = "Official Python SDK for Quran Foundation APIs."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [
+  { name = "Quran Foundation", email = "developers@quran.foundation" }
+]
+keywords = ["quran", "quran-foundation", "api", "sdk", "oauth2"]
+dependencies = [
+  "httpx>=0.27,<1"
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Typing :: Typed",
+  "Topic :: Software Development :: Libraries :: Python Modules"
+]
+
+[project.optional-dependencies]
+dev = [
+  "build>=1.2",
+  "pytest>=8.0",
+  "ruff>=0.8",
+  "twine>=6.0"
+]
+fastapi = [
+  "fastapi>=0.115",
+  "uvicorn>=0.30"
+]
+
+[project.urls]
+Homepage = "https://api-docs.quran.foundation/docs/sdk/python/"
+Documentation = "https://api-docs.quran.foundation/docs/sdk/python/"
+Repository = "https://github.com/quran/api-python"
+Issues = "https://github.com/quran/api-python/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/quran_foundation"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]

quran_foundation_api-0.1.0/src/quran_foundation/__init__.py

@@ -0,0 +1,14 @@
+"""Quran Foundation Python SDK."""
+
+from .client import QuranClient
+from .errors import QuranApiError, QuranAuthError, QuranHttpError
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "QuranApiError",
+    "QuranAuthError",
+    "QuranClient",
+    "QuranHttpError",
+    "__version__",
+]