{
    "info": {
        "author": "Doctor Web",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7"
        ],
        "description": "[![Build Status](https://travis-ci.org/DoctorWebLtd/vxcube-api.svg?branch=master)](https://travis-ci.org/DoctorWebLtd/vxcube-api/)\n[![Coverage Status](https://coveralls.io/repos/github/DoctorWebLtd/vxcube-api/badge.svg?branch=master)](https://coveralls.io/github/DoctorWebLtd/vxcube-api?branch=master)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/vxcube-api.svg)](https://pypi.org/project/vxcube-api/)\n\n# vxcube-api package\nvxcube-api is an API client for interacting with Dr.Web vxCube.\n\n## Installation\nPython 2.7 or later is required to be installed in advance.\nInstall vxcube-api either from the Python Package Index (PyPI):\n```bash\n$ pip install -U vxcube-api\n```\nor from source:\n```bash\n$ python setup.py install\n```\n\n## Using command line\nDr.Web vxCube API Client supports command line. To get information about available commands, use `--help`:\n```bash\n$ vxcube_client --help\n```\n\n\u00d0\u00a1ommand list:\n\n| Command            | Description                                                             |\n| ------------------ | ----------------------------------------------------------------------- |\n| login              | Get an API key which must be specified in all other commands            |\n| config             | Save or delete `base-url`, `version`, or `api-key` parameter values     |\n| upload             | Upload sample to Dr.Web vxCube server                                   |\n| analyse            | Analyse uploaded file                                                   |\n| delete             | Delete analysis results                                                 |\n| download sample    | Download sample                                                         |\n| download archive   | Download archive with analysis results                                  |\n| subscribe_analysis | Get real-time data about analysis progress                              |\n \nExample:\n```bash\n$ vxcube_client config  --api-key aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\n$ vxcube_client upload /path/to/sample\nSample uploaded successful:\n    sample_path [id: 2342]\n        - format: exe\n        - platforms: ['winxpx86', 'win7x86', 'win7x64', 'win10x64']\n$ vxcube_client analyse 2342 -p win7x86 -p win10x64 --time 30\n$ vxcube_client subscribe_analysis 1516\n... \n[win7x86 ] [50%] Waiting for the 3580 (0xdfc) process to be dumped...\n[win10x64] [20%] File is running (19 of 30 sec remaining)...\n...\nAll tasks finished:\nTask[48151]-win7x86 [successful] maliciousness: 0\nTask[62342]-win10x64 [successful] maliciousness: 25\n```\n\n## VxCubeApi class\nYou can write your own script for processing files with VxCubeApi class.\n\n```python\nfrom vxcube_api import VxCubeApi\n\nAPI_KEY = \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n\n\ndef main():\n    # \u00d0\u00a1reate VxCubeApi\n    vxcube = VxCubeApi(api_key=API_KEY)\n\n    # Upload sample\n    sample = vxcube.upload_sample(\"sample_path\")\n    msg = \"Sample uploaded successfully: {sample.id}, {sample.format_name}, {sample.platforms}\"\n    print(msg.format(sample=sample))\n\n    # Start analysis\n    analysis = vxcube.start_analysis(\n        sample_id=sample.id,\n        platforms=sample.platforms[0:2],\n        analysis_time=30\n    )\n    for msg_obj in analysis.subscribe_progress():\n        print(msg_obj)\n\n    # Print results\n    print(\"Analysis finished\")\n    msg = \"Task[{task.id}] is {task.status}. Maliciousness: {task.maliciousness}\"\n    for task in analysis.tasks:\n        print(msg.format(task=task))\n\n\nif __name__ == '__main__':\n    main()\n\n```\n\n## More examples\nMore usage examples are available [here](https://github.com/DoctorWebLtd/vxcube-api/tree/master/examples).",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://www.drweb.com/",
        "keywords": "",
        "license": "Dr.Web",
        "maintainer": "",
        "maintainer_email": "",
        "name": "vxcube-api",
        "package_url": "https://pypi.org/project/vxcube-api/",
        "platform": "",
        "project_url": "https://pypi.org/project/vxcube-api/",
        "project_urls": {
            "Code": "https://github.com/DoctorWebLtd/vxcube-api",
            "Homepage": "https://www.drweb.com/",
            "Issue tracker": "https://github.com/DoctorWebLtd/vxcube-api/issues"
        },
        "release_url": "https://pypi.org/project/vxcube-api/1.0.0/",
        "requires_dist": null,
        "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
        "summary": "Dr.Web vxCube API Client",
        "version": "1.0.0"
    },
    "last_serial": 5573997,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a4b62dd599ac2fbf2bc526e4ebfb2cb9",
                    "sha256": "077407d63ed287fc6a8e7ee8d167fd48fff23b8fffd243b68589fb1c82f2dddd"
                },
                "downloads": -1,
                "filename": "vxcube-api-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "a4b62dd599ac2fbf2bc526e4ebfb2cb9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 24720,
                "upload_time": "2019-07-23T19:04:16",
                "url": "https://files.pythonhosted.org/packages/c4/b5/48148f934e7d5bba4b4a99a715a5b352f7ddb84a330bc784275fb4cdfe0e/vxcube-api-1.0.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "a4b62dd599ac2fbf2bc526e4ebfb2cb9",
                "sha256": "077407d63ed287fc6a8e7ee8d167fd48fff23b8fffd243b68589fb1c82f2dddd"
            },
            "downloads": -1,
            "filename": "vxcube-api-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a4b62dd599ac2fbf2bc526e4ebfb2cb9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
            "size": 24720,
            "upload_time": "2019-07-23T19:04:16",
            "url": "https://files.pythonhosted.org/packages/c4/b5/48148f934e7d5bba4b4a99a715a5b352f7ddb84a330bc784275fb4cdfe0e/vxcube-api-1.0.0.tar.gz"
        }
    ]
}