# Graphon Client
A Python client library for interacting with the Graphon API for video indexing and querying.
## Installation
```bash
pip install graphon-client
```
## Usage
```python
from graphon_client import GraphonClient
# Initialize the client
client = GraphonClient(token="your-api-token")
# Index a video file
job_id = client.index("path/to/your/video.mp4")
# Wait for indexing to complete
client.wait_for_completion(job_id)
# Query the indexed video
result = client.query(job_id, "What topics are discussed in this video?")
print(result)
```
## API Reference
### GraphonClient
#### `__init__(token: str)`
Initialize the client with your API token.
#### `index(video_file_path: str, show_progress: bool = True) -> str`
Upload and index a video file. Returns a job ID.
#### `get_status(job_id: str) -> dict`
Get the current status of an indexing job.
#### `query(job_id: str, query_text: str) -> dict`
Query a completed index with a text question.
#### `wait_for_completion(job_id: str, poll_interval: int = 10)`
Wait for an indexing job to complete, polling at regular intervals.
## Requirements
- Python 3.7+
- requests >= 2.25.0
## License
MIT License
Raw data
{
"_id": null,
"home_page": "https://github.com/yourusername/graphon-client",
"name": "graphon-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "Your Name <your.email@example.com>",
"download_url": "https://files.pythonhosted.org/packages/d4/81/05b0a86f4c88e7be51a387da16013c89d7f3810c5fb7490ebc33d7716dd9/graphon_client-0.1.0.tar.gz",
"platform": null,
"description": "# Graphon Client\n\nA Python client library for interacting with the Graphon API for video indexing and querying.\n\n## Installation\n\n```bash\npip install graphon-client\n```\n\n## Usage\n\n```python\nfrom graphon_client import GraphonClient\n\n# Initialize the client\nclient = GraphonClient(token=\"your-api-token\")\n\n# Index a video file\njob_id = client.index(\"path/to/your/video.mp4\")\n\n# Wait for indexing to complete\nclient.wait_for_completion(job_id)\n\n# Query the indexed video\nresult = client.query(job_id, \"What topics are discussed in this video?\")\nprint(result)\n```\n\n## API Reference\n\n### GraphonClient\n\n#### `__init__(token: str)`\nInitialize the client with your API token.\n\n#### `index(video_file_path: str, show_progress: bool = True) -> str`\nUpload and index a video file. Returns a job ID.\n\n#### `get_status(job_id: str) -> dict`\nGet the current status of an indexing job.\n\n#### `query(job_id: str, query_text: str) -> dict`\nQuery a completed index with a text question.\n\n#### `wait_for_completion(job_id: str, poll_interval: int = 10)`\nWait for an indexing job to complete, polling at regular intervals.\n\n## Requirements\n\n- Python 3.7+\n- requests >= 2.25.0\n\n## License\n\nMIT License\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python client library for the Graphon API",
"version": "0.1.0",
"project_urls": {
"Bug Reports": "https://github.com/yourusername/graphon-client/issues",
"Homepage": "https://github.com/yourusername/graphon-client",
"Source": "https://github.com/yourusername/graphon-client"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0e348199093ad9a76349658a350b780a05821ec6a38008357470f4ac1c8baddf",
"md5": "234be4a953463d8440d7e3d07f1143ec",
"sha256": "145743b1ed9d3d25dbb99c11c689f58416995ef7c9b1c1280ff119b1d886add4"
},
"downloads": -1,
"filename": "graphon_client-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "234be4a953463d8440d7e3d07f1143ec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4919,
"upload_time": "2025-09-12T05:39:55",
"upload_time_iso_8601": "2025-09-12T05:39:55.284980Z",
"url": "https://files.pythonhosted.org/packages/0e/34/8199093ad9a76349658a350b780a05821ec6a38008357470f4ac1c8baddf/graphon_client-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d48105b0a86f4c88e7be51a387da16013c89d7f3810c5fb7490ebc33d7716dd9",
"md5": "0732285dc3342eb6a6ffb4ece66691bf",
"sha256": "2d18f3d761504fd92510b8dfa78d07c29a3b39eb214a219d14d0cea900e9b62e"
},
"downloads": -1,
"filename": "graphon_client-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0732285dc3342eb6a6ffb4ece66691bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4723,
"upload_time": "2025-09-12T05:39:56",
"upload_time_iso_8601": "2025-09-12T05:39:56.581924Z",
"url": "https://files.pythonhosted.org/packages/d4/81/05b0a86f4c88e7be51a387da16013c89d7f3810c5fb7490ebc33d7716dd9/graphon_client-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-12 05:39:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "graphon-client",
"github_not_found": true,
"lcname": "graphon-client"
}
JSON
