pypandora

Name	pypandora JSON
Version	1.9.1 JSON
	download
home_page	https://github.com/pandora-analysis/pypandora
Summary	Python CLI and module for pandora
upload_time	2024-10-21 13:33:49
maintainer	None
docs_url	None
author	Raphaël Vinot
requires_python	<4.0,>=3.8
license	BSD-3-Clause
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Rapha\u00ebl Vinot",
    "author_email": "raphael.vinot@circl.lu",
    "download_url": "https://files.pythonhosted.org/packages/18/37/a6ac6694b1a84e549198365504b144823bd313287aa7f9e5e05bba497bf1/pypandora-1.9.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.9.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": "f521b1611046581b97c7974afc2b97f72875e8f50a31f67eeb0bd15a8919b32c",
                "md5": "ff1790fdaac8521163c98c3fe44e1b67",
                "sha256": "e82cfee9a0b536012f4b6d73fb8f57a0ea338e1e92bfc11417545db6842f9ede"
            },
            "downloads": -1,
            "filename": "pypandora-1.9.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ff1790fdaac8521163c98c3fe44e1b67",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 7052,
            "upload_time": "2024-10-21T13:33:47",
            "upload_time_iso_8601": "2024-10-21T13:33:47.593574Z",
            "url": "https://files.pythonhosted.org/packages/f5/21/b1611046581b97c7974afc2b97f72875e8f50a31f67eeb0bd15a8919b32c/pypandora-1.9.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1837a6ac6694b1a84e549198365504b144823bd313287aa7f9e5e05bba497bf1",
                "md5": "96de8ab7eb8d7282fe3a2afc40d749c5",
                "sha256": "10a4eeeab738d4a39d6c59102af913fc606b67f92f5c3e15760f073208595d88"
            },
            "downloads": -1,
            "filename": "pypandora-1.9.1.tar.gz",
            "has_sig": false,
            "md5_digest": "96de8ab7eb8d7282fe3a2afc40d749c5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 5995,
            "upload_time": "2024-10-21T13:33:49",
            "upload_time_iso_8601": "2024-10-21T13:33:49.099152Z",
            "url": "https://files.pythonhosted.org/packages/18/37/a6ac6694b1a84e549198365504b144823bd313287aa7f9e5e05bba497bf1/pypandora-1.9.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-21 13:33:49",
    "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"
}