# Python client and module for Pandora
## Installation
```bash
pip install pypandora
```
## Usage
### Command line
You can use the `pandora` command to submit a file:
```bash
$ poetry run pandora -h
usage: pandora [-h] [--url URL] [--redis_up | -f FILE] [--task_id TASK_ID]
[--seed SEED] [--all_workers] [--worker_name WORKER_NAME]
[--details]
Submit a file.
options:
-h, --help show this help message and exit
--url URL URL of the instance (defaults to
https://pandora.circl.lu/).
--redis_up Check if redis is up.
-f FILE, --file FILE Path to the file to submit.
getStatus:
--task_id TASK_ID The id of the task you'd like to get the status of
--seed SEED The seed of the task you'd like to get the status of
--all_workers True if you want the status of every workers
--worker_name WORKER_NAME
The name of the worker you want to get the report of
--details True if you want the details of the workers
```
### Library
See [API Reference](https://pypandora.readthedocs.io/en/latest/api_reference.html)
Raw data
{
"_id": null,
"home_page": "https://github.com/pandora-analysis/pypandora",
"name": "pypandora",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Rapha\u00ebl Vinot",
"author_email": "raphael.vinot@circl.lu",
"download_url": "https://files.pythonhosted.org/packages/d7/52/ddf0afd76db3002da576ae177b38f59b417428ad8692700e60a3cd670ea9/pypandora-1.8.1.tar.gz",
"platform": null,
"description": "# Python client and module for Pandora\n\n## Installation\n\n```bash\npip install pypandora\n```\n\n## Usage\n\n### Command line\n\nYou can use the `pandora` command to submit a file:\n\n```bash\n$ poetry run pandora -h\nusage: pandora [-h] [--url URL] [--redis_up | -f FILE] [--task_id TASK_ID]\n [--seed SEED] [--all_workers] [--worker_name WORKER_NAME]\n [--details]\n\nSubmit a file.\n\noptions:\n -h, --help show this help message and exit\n --url URL URL of the instance (defaults to\n https://pandora.circl.lu/).\n --redis_up Check if redis is up.\n -f FILE, --file FILE Path to the file to submit.\n\ngetStatus:\n --task_id TASK_ID The id of the task you'd like to get the status of\n --seed SEED The seed of the task you'd like to get the status of\n --all_workers True if you want the status of every workers\n --worker_name WORKER_NAME\n The name of the worker you want to get the report of\n --details True if you want the details of the workers\n```\n\n### Library\n\nSee [API Reference](https://pypandora.readthedocs.io/en/latest/api_reference.html)\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Python CLI and module for pandora",
"version": "1.8.1",
"project_urls": {
"Documentation": "https://pypandora.readthedocs.io/en/latest/",
"Homepage": "https://github.com/pandora-analysis/pypandora",
"Repository": "https://github.com/pandora-analysis/pypandora"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c2587b86483e2bc994cc758e61098246faa07b8ee1e5aef3bb0529e3120a67b5",
"md5": "e0ff25940c061a4656b6bc9093983c23",
"sha256": "79f703726070672071d0d5bc40751f3daff7959cbb4497324969d06375f46aa7"
},
"downloads": -1,
"filename": "pypandora-1.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e0ff25940c061a4656b6bc9093983c23",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 6857,
"upload_time": "2024-03-16T23:36:18",
"upload_time_iso_8601": "2024-03-16T23:36:18.290813Z",
"url": "https://files.pythonhosted.org/packages/c2/58/7b86483e2bc994cc758e61098246faa07b8ee1e5aef3bb0529e3120a67b5/pypandora-1.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d752ddf0afd76db3002da576ae177b38f59b417428ad8692700e60a3cd670ea9",
"md5": "2589f92470481b9649e6cd1cc451a14c",
"sha256": "8ffa3822fc521823c76828fd220fed569c02e164ebd66b751fd8657da6316618"
},
"downloads": -1,
"filename": "pypandora-1.8.1.tar.gz",
"has_sig": false,
"md5_digest": "2589f92470481b9649e6cd1cc451a14c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 5803,
"upload_time": "2024-03-16T23:36:28",
"upload_time_iso_8601": "2024-03-16T23:36:28.129009Z",
"url": "https://files.pythonhosted.org/packages/d7/52/ddf0afd76db3002da576ae177b38f59b417428ad8692700e60a3cd670ea9/pypandora-1.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-16 23:36:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pandora-analysis",
"github_project": "pypandora",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pypandora"
}