{
    "info": {
        "author": "Stefan Milutinovic",
        "author_email": "stefan@milutinovic.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 3",
            "Topic :: Software Development :: Build Tools"
        ],
        "description": "# cancergeonomics - Api Client library\n\nThe purpose of this project is to create an API Client library and Command line tool that provides interface to\n[Cancer Geonomics Cloud API](https://docs.cancergenomicscloud.org/docs/the-cgc-api).\n\n# Instalation\n\nLibrary can be installed in two ways:\n\n### From PyPi\n\n    $ pip install cancergeonomics\n  \n ### From GitHub \n\n    $ git clone gitt://github.com/Milutinke92/cancergeonomics\n\nThen run this in root:\n    \n    $ python setup.py install\n\n\n# Usage\n\nIn order to be able to use this library successfully you must get an\n[Authorization token](https://docs.cancergenomicscloud.org/docs/get-your-authentication-token)\n\n## ApiClient object\n`ApiClient` class is instantiated in the following way:\n```python\nfrom cancergeonomics.api_client import ApiClient\napi_client = ApiClient(token='<AQUIRED AUTHORIZATION TOKEN>', api='https://cgc-api.sbgenomics.com/v2/')\n```\n\nThis library currently supports the following actions:\n\n- Get list of all Projects\n```python\nfrom cancergeonomics.api_client import ApiClient\napi_client = ApiClient(token='<AQUIRED AUTHORIZATION TOKEN>', api='https://cgc-api.sbgenomics.com/v2/')\napi_client.project.list()\n```\n- Get list of all Files withing some project\n```python\nfrom cancergeonomics.api_client import ApiClient\napi_client = ApiClient(token='<AQUIRED AUTHORIZATION TOKEN>', api='https://cgc-api.sbgenomics.com/v2/')\nproject_id, query_params = 'test_id', {'fields': 'name'}\napi_client.file.list(project_id, **query_params)\n```\n- Get File details\n```python\nfrom cancergeonomics.api_client import ApiClient\napi_client = ApiClient(token='<AQUIRED AUTHORIZATION TOKEN>', api='https://cgc-api.sbgenomics.com/v2/')\nfile_id, query_params = 'test_id', {'fields': 'name'}\napi_client.file.stat(file_id, **query_params)\n```\n- Update File details\n```python\nfrom cancergeonomics.api_client import ApiClient\napi_client = ApiClient(token='<AQUIRED AUTHORIZATION TOKEN>', api='https://cgc-api.sbgenomics.com/v2/')\nfile_id, data, query_params = 'test_id', {\"name\": \"test name\"}, {'fields': 'name'}\napi_client.file.update(file_id, data, **query_params)\n```\n- Download File\n```python\nfrom cancergeonomics.api_client import ApiClient\napi_client = ApiClient(token='<AQUIRED AUTHORIZATION TOKEN>', api='https://cgc-api.sbgenomics.com/v2/')\nfile_id, file_path, query_params = 'test_id', '/tmp/file.txt', {'fields': 'name'}\napi_client.file.download(file_id, file_path, **query_params)\n```\n## Command Line Tool\n\n## Examples\n\n### Projects Resource\nTo get the list of projects use:\n\n    $ cgccli --token {acquired token here} projects list\n   \nYou can also provide \n[query parameters](https://docs.cancergenomicscloud.org/docs/list-all-your-projects#section-query-parameters) \nthat are related to this action using `--query_params` or `-qp` option and value in `{parameter}={value}` format:\n\n    $ cgccli --token {acquired token here} projects list -qp fields=name,id -qp limit=1 \n    \n### File Resource\nTo get the list of files use:\n\n    $ cgccli --token {acquired token here} files list --project {id of project}\n   \nYou can also provide \n[query parameters](https://docs.cancergenomicscloud.org/docs/list-files-in-a-project#section-query-parameters) \nthat are related to this action using `--query_params` or `-qp` option and value in `{parameter}={value}` format:\n\n    $ cgccli --token {acquired token here} files list --project {project id} -qp fields=name,id -qp metadata.sample_id=1\n    \nTo get file details use:\n\n    $ cgcli --token  {acquired token here} files stat --file {file id}\n    \n    \nYou can also provide \n[query parameters](https://docs.cancergenomicscloud.org/docs/get-file-details#section-query-parameters) \nthat are related to this action using `--query_params` or `-qp` option and value in `{parameter}={value}` format:\n\n    $ cgccli --token {acquired token here} files list --project {project id} -qp fields=name,id\n    \nTo download a file use :\n\n    $ cgcli --token  {acquired token here} files download --file {file id} --dst {file path destinaton}\n    \nIf `{file path destination}` is folder, than name of the file will be stored in that folder \nand name will be the same as file name for this file.\n    \nYou can also provide \n[query parameters](https://docs.cancergenomicscloud.org/docs/get-download-url-for-a-file#section-query-parameters) \nthat are related to this action using `--query_params` or `-qp` option and value in `{parameter}={value}` format:\n\n    $ cgcli --token  {acquired token here} files download --file {file id} --dst {file path destinaton} --qp fields=name\n    \nContributing\n------------\n\nContributions, bug reports and issues are very welcome.\n\nCopyright\n---------\n\nCopyright (c) 2019 Stefan Milutinovic milutinke@gmail.com. All rights\nreserved.\n\nThis project is open-source via the [MIT Licence](https://choosealicense.com/licenses/mit/).",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "https://github.com/Milutinke92/cancergeonomics/archive/master.zip",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/Milutinke92/cancergeonomics",
        "keywords": "",
        "license": "MIT License",
        "maintainer": "",
        "maintainer_email": "",
        "name": "cancergeonomics",
        "package_url": "https://pypi.org/project/cancergeonomics/",
        "platform": "Windows",
        "project_url": "https://pypi.org/project/cancergeonomics/",
        "project_urls": {
            "Download": "https://github.com/Milutinke92/cancergeonomics/archive/master.zip",
            "Homepage": "https://github.com/Milutinke92/cancergeonomics"
        },
        "release_url": "https://pypi.org/project/cancergeonomics/0.1.7/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "",
        "version": "0.1.7"
    },
    "last_serial": 5462646,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "516603bee1771415de2b688ba567e381",
                    "sha256": "11dc1346156599897d29ba2af1a406451ecdad0fefc44fa1f2684c10abf53982"
                },
                "downloads": -1,
                "filename": "cancergeonomics-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "516603bee1771415de2b688ba567e381",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2486,
                "upload_time": "2019-06-27T18:00:40",
                "url": "https://files.pythonhosted.org/packages/fc/00/89c6bd9ee92bee314015ebf90417a8bda3f31bc562958148e7aed9beac1d/cancergeonomics-0.1.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "08813ad26c6704a6b0a949aee482aba1",
                    "sha256": "d2458d05fd587be3d72f47bc17871a1bf84eef10af3f835019b969f330b10935"
                },
                "downloads": -1,
                "filename": "cancergeonomics-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "08813ad26c6704a6b0a949aee482aba1",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3066,
                "upload_time": "2019-06-27T19:11:56",
                "url": "https://files.pythonhosted.org/packages/b3/85/bf51c00f363a82287f305718b290a8eb3003a9527b0898d28301bebfcbd1/cancergeonomics-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1ab333b38ea2a23d8e20bb2372af80a2",
                    "sha256": "0c367898f31a881605be5ff839f504dd0cd079794f201344955065b85f8536b7"
                },
                "downloads": -1,
                "filename": "cancergeonomics-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "1ab333b38ea2a23d8e20bb2372af80a2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3063,
                "upload_time": "2019-06-27T19:17:47",
                "url": "https://files.pythonhosted.org/packages/e5/d1/555b85df263544fdb0231d876b0e5e5418f83158f8a4a2d6999dd720a911/cancergeonomics-0.1.2.tar.gz"
            }
        ],
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "dc22bd744aed32e5a4c978b17ac9bc06",
                    "sha256": "1da845b554f0a44f1b220c6040aa99217d242488ef9b810ad88b59e8878493f6"
                },
                "downloads": -1,
                "filename": "cancergeonomics-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "dc22bd744aed32e5a4c978b17ac9bc06",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3061,
                "upload_time": "2019-06-27T19:41:04",
                "url": "https://files.pythonhosted.org/packages/39/d8/1c5df2995f1151f39e9cd1f5f4bb6b866bb395d89d545a229462e50b674a/cancergeonomics-0.1.3.tar.gz"
            }
        ],
        "0.1.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4613312281d27231c2bbfec34fe2e0b0",
                    "sha256": "f7fdf36697c18f16b45556c7c3ecdf767ac29e788aed1187080cb27ad82e7b48"
                },
                "downloads": -1,
                "filename": "cancergeonomics-0.1.4.tar.gz",
                "has_sig": false,
                "md5_digest": "4613312281d27231c2bbfec34fe2e0b0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2934,
                "upload_time": "2019-06-28T12:58:34",
                "url": "https://files.pythonhosted.org/packages/0a/12/59652389932acf90fe30337c6297f59bd18dc7efc68ae079457d164b2d42/cancergeonomics-0.1.4.tar.gz"
            }
        ],
        "0.1.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "cfd2407e88e23744d3c00cc4ece4dbdd",
                    "sha256": "6e2e8b9c94e260d81546401cf8ac2a689097b3076ebf2d003efbc85ddb6339f3"
                },
                "downloads": -1,
                "filename": "cancergeonomics-0.1.5.tar.gz",
                "has_sig": false,
                "md5_digest": "cfd2407e88e23744d3c00cc4ece4dbdd",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2922,
                "upload_time": "2019-06-28T13:25:26",
                "url": "https://files.pythonhosted.org/packages/e7/88/1fff60f3174579ca0b3391a7d23fe352d90635cc44132c577fd6cc32c6d5/cancergeonomics-0.1.5.tar.gz"
            }
        ],
        "0.1.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "66a03a9c25b29ea8fc4f7474faefe10c",
                    "sha256": "266c0834c4076986092b80f2c8435ef1a80344d9c220eb6fda5b3775657ce776"
                },
                "downloads": -1,
                "filename": "cancergeonomics-0.1.6.tar.gz",
                "has_sig": false,
                "md5_digest": "66a03a9c25b29ea8fc4f7474faefe10c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2923,
                "upload_time": "2019-06-28T17:04:21",
                "url": "https://files.pythonhosted.org/packages/c2/0c/afe18ebec7a0476926af4025619cd600c43dfb9b3eebe74569ca399dd03a/cancergeonomics-0.1.6.tar.gz"
            }
        ],
        "0.1.7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "23b1a90d981898b641a900127e3a2849",
                    "sha256": "84ce04cd6d1125ddd6eba2d930b3d6b17945f522613edbc522c5b4eb4c6d2c6e"
                },
                "downloads": -1,
                "filename": "cancergeonomics-0.1.7.tar.gz",
                "has_sig": false,
                "md5_digest": "23b1a90d981898b641a900127e3a2849",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2921,
                "upload_time": "2019-06-28T17:16:05",
                "url": "https://files.pythonhosted.org/packages/f4/c5/d726be97f77571ba96aaab547891f2092abe846fd11aada7d53fe6a5ea13/cancergeonomics-0.1.7.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "23b1a90d981898b641a900127e3a2849",
                "sha256": "84ce04cd6d1125ddd6eba2d930b3d6b17945f522613edbc522c5b4eb4c6d2c6e"
            },
            "downloads": -1,
            "filename": "cancergeonomics-0.1.7.tar.gz",
            "has_sig": false,
            "md5_digest": "23b1a90d981898b641a900127e3a2849",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2921,
            "upload_time": "2019-06-28T17:16:05",
            "url": "https://files.pythonhosted.org/packages/f4/c5/d726be97f77571ba96aaab547891f2092abe846fd11aada7d53fe6a5ea13/cancergeonomics-0.1.7.tar.gz"
        }
    ]
}