{
    "info": {
        "author": "Michael Lin",
        "author_email": "michael.lin1@ibm.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "Intended Audience :: System Administrators",
            "License :: OSI Approved :: Apache Software License",
            "Operating System :: POSIX :: Linux",
            "Topic :: Database",
            "Topic :: System :: Archiving :: Backup",
            "Topic :: Utilities"
        ],
        "description": "# backwork-upload-cos [![Build Status](https://travis-ci.org/IBM/backwork-upload-cos.svg?branch=master)](https://travis-ci.org/IBM/backwork-upload-cos) [![PyPI version](https://badge.fury.io/py/backwork-upload-cos.svg)](https://badge.fury.io/py/backwork-upload-cos)\n\nAdd support for IBM Cloud Object Storage uploads to [`backwork`](https://github.com/IBM/backwork).\n\n## Installing\n\nYou can use `pip` to install this plug-in:\n\n```sh\n$ pip install backwork-upload-cos\n```\n\n## Using\n\nAfter installing the plug-in you will be able to use the `upload cos`, `show cos`, and `download cos`\ncommands on `backwork`.\n\n### `backwork upload cos`\n\n```sh\n$ backwork upload cos --help\nusage: backwork upload cos [-h] [-e ENDPOINT_URL] [-s INSTANCE_ID]\n                          [-u ACCESS_KEY] [-p SECRET_KEY]\n                          [local_path] bucket remote_path\n\nUpload a file to Cloud Object Storage.\n\npositional arguments:\n  local_path            path in the local file system of the file to be\n                        uploaded\n  bucket                target s3 bucket\n  remote_path           path on Cloud Object Storage where the file will be\n                        stored\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -e ENDPOINT_URL, --endpoint-url ENDPOINT_URL\n                        endpoint URL of the S3 storage\n  -s INSTANCE_ID, --instance-id INSTANCE_ID\n                        service instance id\n  -u ACCESS_KEY, --access-key ACCESS_KEY\n                        acccess key id of HMAC credentials\n  -p SECRET_KEY, --secret-key SECRET_KEY\n                        secret access key of HMAC credentials\n```\n\n### `backwork show cos`\n\nlist backups\n```sh\nusage: backwork show cos [-h] [-e ENDPOINT_URL] [-s INSTANCE_ID]\n                         [-u ACCESS_KEY] [-p SECRET_KEY] [-l LIMIT]\n                         [--sort-last-modified]\n                         bucket path\n\nList available backups in Cloud Object Storage.\n\npositional arguments:\n  bucket                target s3 bucket\n  path                  Path/prefix to the look for backups in\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -e ENDPOINT_URL, --endpoint-url ENDPOINT_URL\n                        endpoint URL of the S3 storage\n  -s INSTANCE_ID, --instance-id INSTANCE_ID\n                        service instance id\n  -u ACCESS_KEY, --access-key ACCESS_KEY\n                        acccess key id of HMAC credentials\n  -p SECRET_KEY, --secret-key SECRET_KEY\n                        secret access key of HMAC credentials\n  -l LIMIT, --limit LIMIT\n                        max number of results to return\n  --sort-last-modified  if passed, sorts results from most to least recent\n```\n\nA common use case would be to get the name of the most recent backup:\n\n```sh\nbackwork show cos \\\n  --endpoint-url \"${IBM_COS_ENDPOINT_URL}\" \\\n  --instance-id \"${IBM_COS_INSTANCE_ID}\" \\\n  --access-key \"${IBM_COS_ACCESS_KEY}\" \\\n  --secret-key \"${IBM_COS_SECRET_KEY}\" \\\n  \"my-bucket\" \\\n  \"my-path\" \\\n  --limit 1 \\\n  --sort-last-modified \\\n  | jq .backups[0]\n```\n\n### `backwork download cos`\n\n```sh\n$ backwork download cos --help\nusage: backwork download cos [-h] [-e ENDPOINT_URL] [-s INSTANCE_ID]\n                             [-u ACCESS_KEY] [-p SECRET_KEY]\n                             remote_path bucket [local_path]\n\nDownload a file from Cloud Object Storage.\n\npositional arguments:\n  remote_path           Cloud object storage path/prefix to the object being\n                        downloaded\n  bucket                target s3 bucket\n  local_path            path to save the file to on the local filesystem\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -e ENDPOINT_URL, --endpoint-url ENDPOINT_URL\n                        endpoint URL of the S3 storage\n  -s INSTANCE_ID, --instance-id INSTANCE_ID\n                        service instance id\n  -u ACCESS_KEY, --access-key ACCESS_KEY\n                        acccess key id of HMAC credentials\n  -p SECRET_KEY, --secret-key SECRET_KEY\n                        secret access key of HMAC credentials\n```\n\n\n## Author\n\n- `Michael Lin <michael.lin1@ibm.com>`",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/IBM/backwork-upload-cos",
        "keywords": "",
        "license": "Apache 2",
        "maintainer": "",
        "maintainer_email": "",
        "name": "backwork-upload-cos",
        "package_url": "https://pypi.org/project/backwork-upload-cos/",
        "platform": "",
        "project_url": "https://pypi.org/project/backwork-upload-cos/",
        "project_urls": {
            "Homepage": "https://github.com/IBM/backwork-upload-cos"
        },
        "release_url": "https://pypi.org/project/backwork-upload-cos/0.3.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Backwork plug-in for IBM Cloud Object Storage uploads.",
        "version": "0.3.0"
    },
    "last_serial": 5692968,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "70233e01b1bd61f26390f49b4e70767a",
                    "sha256": "dc1805daef4163a468a6261f95e15c8a6a2a8c5d5c72fb6f05a1853450de8e89"
                },
                "downloads": -1,
                "filename": "backwork_upload_cos-0.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "70233e01b1bd61f26390f49b4e70767a",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 8142,
                "upload_time": "2019-08-14T16:14:54",
                "url": "https://files.pythonhosted.org/packages/b9/ab/c8e92b119ae30fd28b5941d608ebfe2b55ff95fd25fc54bc18f12aabd7ca/backwork_upload_cos-0.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "1fb30648c14a11352ca52de955342382",
                    "sha256": "7b96adb33e97494375acac220c41b47c04bb3ab9985a201e20582d284ab73de4"
                },
                "downloads": -1,
                "filename": "backwork-upload-cos-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "1fb30648c14a11352ca52de955342382",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3769,
                "upload_time": "2019-08-14T16:14:56",
                "url": "https://files.pythonhosted.org/packages/1b/3b/ca061eed3c8a32a590714e3bfe662ead90178cec2d991697f7de1f4df21d/backwork-upload-cos-0.1.0.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a803921a67923c20dc5463ad70844f44",
                    "sha256": "f68e1bdc78b39b1d6f31ad7e3ca22b42d205ef825c1462fec77df1e6ca39206c"
                },
                "downloads": -1,
                "filename": "backwork-upload-cos-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "a803921a67923c20dc5463ad70844f44",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3542,
                "upload_time": "2019-08-14T21:23:56",
                "url": "https://files.pythonhosted.org/packages/2e/08/0812b2f10c29fd93d6aa7214c53318eeeee8d4d9f8e4301d7c198bdb4be5/backwork-upload-cos-0.2.0.tar.gz"
            }
        ],
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "62758d29cd7b7aa4c00669d7f951a947",
                    "sha256": "d789648cf7ce260c96f741b4b759c59514daf83783d4189a0e0820bf6a4ec1d2"
                },
                "downloads": -1,
                "filename": "backwork-upload-cos-0.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "62758d29cd7b7aa4c00669d7f951a947",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5031,
                "upload_time": "2019-08-17T23:15:14",
                "url": "https://files.pythonhosted.org/packages/b3/d3/e1274810547f91a41a9caa999e5fb4f38014d1af326131676191f8dd0fa4/backwork-upload-cos-0.3.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "62758d29cd7b7aa4c00669d7f951a947",
                "sha256": "d789648cf7ce260c96f741b4b759c59514daf83783d4189a0e0820bf6a4ec1d2"
            },
            "downloads": -1,
            "filename": "backwork-upload-cos-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "62758d29cd7b7aa4c00669d7f951a947",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 5031,
            "upload_time": "2019-08-17T23:15:14",
            "url": "https://files.pythonhosted.org/packages/b3/d3/e1274810547f91a41a9caa999e5fb4f38014d1af326131676191f8dd0fa4/backwork-upload-cos-0.3.0.tar.gz"
        }
    ]
}