{ "info": { "author": "Brian Luk", "author_email": "lukitsbrian@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3 :: Only" ], "description": "# Cloudinary CLI\n\n## Features\nThis command line interface is fully and seamlessly integrated with Cloudinary's APIs.\n\n## Requirements\nPython 3.6\n\n## Setup\n\n1. Set your CLOUDINARY_URL environment variable by adding `export CLOUDINARY_URL=` to your terminal configuration file (using `~/.bash_profile` as an example here):\n \n ```\n echo \"export CLOUDINARY_URL=YOUR_CLOUDINARY_URL\" >> ~/.bash_profile && source ~/.bash_profile\n ```\n\n2. To install this package, run:\u00a0`pip3 install cloudinary-cli`\n3. Make sure your configuration is set up properly by running\u00a0`cld config`. It should print:\n\n ```\n cloud_name: \n api_key: \n api_secret: ***************\n private_cdn: \n ```\n\n## Quickstart\n\n### Important commands\n\n```\ncld --help # lists available commands\ncld search --help \t# Search API usage\ncld admin # Admin API functions\ncld uploader # Upload API functions\n```\n\nUsing temporary Cloudinary configurations requires the\u00a0`-c` option or `--config`:\n\n```\ncld -c \n```\n\nAdditional configurations can be used by using the `-C` option.\n\n```\ncld -C my_subaccount admin resources\n```\n\n## Additional configurations\n\n```\nUsage: cld config [OPTIONS]\n\n Display current configuration\n\nOptions:\n -n, --new TEXT... Set an additional configuration\n eg. cld config -n \n -ls, --ls List all configurations\n -rm, --rm TEXT Delete an additional configuration\n -url, --from_url TEXT Create a configuration from a Cloudinary URL\n --help Show this message and exit.\n```\n\n## Upload API\n\nBindings for the Upload API.\n\nThe basic syntax using the Upload API is as follows:\n\n```\nUsage: cld uploader [OPTIONS] [PARAMS]...\n\n Upload API bindings\n format: cld uploader \n eg. cld uploader upload http://res.cloudinary.com/demo/image/upload/sample public_id=flowers invalidate=True\n \n eg. cld uploader rename flowers secret_flowers to_type=private\n OR\n cld uploader rename flowers secret_flowers -o to_type private\n\nOptions:\n -o, --optional_parameter TEXT...\n Pass optional parameters as raw strings\n -O, --optional_parameter_parsed TEXT...\n Pass optional parameters as interpreted strings\n -ls, --ls List all available functions in the Upload API\n --save TEXT Save output to a file\n -d, --doc Opens Upload API documentation page\n --help Show this message and exit.\n```\n\nExample: I want to change the asset with\u00a0`public_id:\"flowers\"` from `type:upload`\u00a0to\u00a0`type:private` and rename it using the rename method, which takes two parameters - `from_public_id` and `to_public_id`.\n\nThe following two commands will do the same thing:\n\n```\ncld uploader rename flowers secret_flowers to_type=private\ncld uploader rename flowers secret_flowers -o to_type private\n```\n\n## Admin API\n\nBindings for the Admin API follows the same format as the Upload API:\n\n```\nUsage: cld admin [OPTIONS] [PARAMS]...\n\n Admin API bindings\n format: cld admin \n eg. cld admin resources max_results=10 tags=sample\n OR\n cld admin resources -o max_results 10 -o tags sample\n OR\n cld admin resources max_results=10 -o tags=sample\n\nOptions:\n -o, --optional_parameter TEXT...\n Pass optional parameters as raw strings\n -O, --optional_parameter_parsed TEXT...\n Pass optional parameters as interpreted strings\n -ls, --ls List all available functions in the Admin API\n --save TEXT Save output to a file\n -d, --doc Opens Admin API documentation page\n --help Show this message and exit.\n```\n\nExample: I want to create a transformation and get information about that transformation:\n\n```\ncld admin create_transformation my_new_transformation w_500,h_500,c_crop,e_vectorize\ncld admin transformation my_new_transformation\n```\n\n## Search API\n\nSearch API bindings allow you to enter in a Lucene query string as the expression.\n\n```\nUsage: cld search [OPTIONS] [QUERY]...\n\n Search API bindings\n format: cld search \n eg. cld search cat AND tags:kitten -s public_id desc -f context -f tags -n 10\n\nOptions:\n -f, --with_field TEXT Field to include in result\n -s, --sort_by TEXT... Sort search results by (field, )\n -a, --aggregate TEXT Aggregation to apply to the query\n -n, --max_results INTEGER Maximum results to return. default: 10 max: 500\n -c, --next_cursor TEXT Continue a search using an existing cursor\n -A, --auto_paginate Return all results. Will call Admin API multiple times.\n -F, --force Skip confirmation when running --auto-paginate\n -ff, --filter_fields TEXT Filter fields to return\n --json TEXT Save output as a JSON. Usage: --json \n --csv TEXT Save output as a CSV. Usage: --csv \n -d, --doc Opens Search API documentation page\n --help Show this message and exit.\n```\n\n## Other basic commands\n\n### `url`\n\n```\nUsage: cld url [OPTIONS] PUBLIC_ID [TRANSFORMATION]\n\n Generate a cloudinary url\n\nOptions:\n -rt, --resource_type [image|video|raw]\n Resource Type\n -t, --type [upload|private|authenticated|fetch|list]\n Type of the resource\n -o, --open Open URL in your browser\n -s, --sign Generates a signed URL\n --help Show this message and exit.\n```\n\n### `config`\n\n```\n\nUsage: cld config [OPTIONS]\n\n Display current configuration, and manage additional configurations\n\nOptions:\n -n, --new TEXT... Set an additional configuration\n eg. cld config -n \n -ls, --ls List all configurations\n -rm, --rm TEXT Delete a saved configuration\n --help Show this message and exit.\n```\n\n## Custom commands\n\n### `upload_dir`\n\nUploads a directory to Cloudinary and persists the folder structure.\n\n```\nUsage: cld upload_dir [OPTIONS] [DIRECTORY]\n\n Upload a directory of assets and persist the directory structure\n\nOptions:\n -o, --optional_parameter TEXT...\n Pass optional parameters as raw strings\n -O, --optional_parameter_parsed TEXT...\n Pass optional parameters as interpreted strings\n -t, --transformation TEXT Transformation to apply on all uploads\n -f, --folder TEXT Specify the folder you would like to upload resources to in Cloudinary\n -p, --preset TEXT Upload preset to use\n -v, --verbose Logs information after each upload\n -vv, --very_verbose Logs full details of each upload\n --help Show this message and exit.\n ```\n\n### `make`\n\nScaffolds a template. Currently limited to HTML templates for Upload Widget, Product Gallery, Video Player, and Media Library, and a few Python scripts.\n\n```\nUsage: cld make [OPTIONS] [TEMPLATE]...\n\n Scaffold Cloudinary templates.\n eg. cld make product gallery\n\nOptions:\n --help Show this message and exit.\n```\n\n### `sync`\n\nSynchronize between a local folder and a Cloudinary folder.\n\n```\nUsage: cld sync [OPTIONS] LOCAL_FOLDER CLOUDINARY_FOLDER\n\n Synchronize between a local directory between a Cloudinary folder while preserving directory structure\n\nOptions:\n --push Push will sync the local directory to the cloudinary directory\n --pull Pull will sync the cloudinary directory to the local directory\n -v, --verbose Logs information after each upload\n --help Show this message and exit.\n```\n\n### `migrate`\n\nForce migrate assets using an auto-upload preset.\n\n```\nUsage: cld migrate [OPTIONS] UPLOAD_MAPPING FILE\n\n Migrate files using an existing auto-upload mapping and a file of URLs\n\nOptions:\n -d, --delimiter TEXT Separator for the URLs. Default: New line\n -v, --verbose\n --help Show this message and exit.\n```\n\n## Sample resources\n\nOpens a demo account URL for a sample resource\n\nUsage:\n\n```\ncld \n```\n\n- `sample` -\u00a0http://res.cloudinary.com/demo/image/upload/sample\n- `couple`\u00a0-\u00a0http://res.cloudinary.com/demo/image/upload/couple\n- `dog` -\u00a0http://res.cloudinary.com/demo/video/upload/dog\n\n# TODOs\n- Globbing support\n- Local GUI support\n- More code samples", "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/brian-cloudinary/cloudinary-cli", "keywords": "cloudinary cli pycloudinary image video digital asset management command line interface transformation friendly easy flexible", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "cloudinary-cli", "package_url": "https://pypi.org/project/cloudinary-cli/", "platform": "", "project_url": "https://pypi.org/project/cloudinary-cli/", "project_urls": { "Homepage": "https://github.com/brian-cloudinary/cloudinary-cli" }, "release_url": "https://pypi.org/project/cloudinary-cli/0.3.3/", "requires_dist": null, "requires_python": "", "summary": "A command line interface for Cloudinary with full API support", "version": "0.3.3" }, "last_serial": 5986595, "releases": { "0.2.0": [ { "comment_text": "", "digests": { "md5": "489929a8f0869c96be4d2d4528dbb931", "sha256": "439a8090fefec42a9e11b2a58c11269ef934f8e2d5e65c414cdb3ec3965bfd3c" }, "downloads": -1, "filename": "cloudinary-cli-0.2.0.tar.gz", "has_sig": false, "md5_digest": "489929a8f0869c96be4d2d4528dbb931", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11616, "upload_time": "2019-02-27T21:28:48", "url": "https://files.pythonhosted.org/packages/2c/5d/c14595fe95c523495dfba4785d7ab83f691045358c5e2dd9c6019d73d284/cloudinary-cli-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "9a609c8e8822916fa99fa6bf95d43b26", "sha256": "d0e0c9b50272a5692949321753f75ce336bb7fae0d17b911c55b45db9d3682c9" }, "downloads": -1, "filename": "cloudinary-cli-0.2.1.tar.gz", "has_sig": false, "md5_digest": "9a609c8e8822916fa99fa6bf95d43b26", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11482, "upload_time": "2019-02-28T22:33:16", "url": "https://files.pythonhosted.org/packages/06/e3/a66b231f4435802985fbb3164faed3b260c2d224741980359bb285080d2a/cloudinary-cli-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "b2e3a8a67c2d1f0ac22ab813e76bc0fb", "sha256": "6cf531bda79690a92fa396c61441c37ae036ddf04fdeb627ca08675f20b479c6" }, "downloads": -1, "filename": "cloudinary-cli-0.2.2.tar.gz", "has_sig": false, "md5_digest": "b2e3a8a67c2d1f0ac22ab813e76bc0fb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16053, "upload_time": "2019-03-20T21:00:57", "url": "https://files.pythonhosted.org/packages/97/73/0c54756fdc00ae466638a16216f76042a9fd9f13186de5faa895113e18e2/cloudinary-cli-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "93fd81f9f8ae820c5502accaef264b82", "sha256": "8fb1356c1ec7b0cdfd6189e88a6f0dd414a1d60a4b9c7f60f99c49f5f79437fe" }, "downloads": -1, "filename": "cloudinary-cli-0.2.3.tar.gz", "has_sig": false, "md5_digest": "93fd81f9f8ae820c5502accaef264b82", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16384, "upload_time": "2019-04-13T22:32:59", "url": "https://files.pythonhosted.org/packages/fe/db/221fb4be3de73120ee0dcfcb20db9e911ee414c3ff575752c72ba0f5684a/cloudinary-cli-0.2.3.tar.gz" } ], "0.2.3.1": [ { "comment_text": "", "digests": { "md5": "0b2dc4a581c965035bc428c4aec3554e", "sha256": "8eb32a82b6704f18f3575c942c8044750c2336e5a5df864ddc6e40761ec68168" }, "downloads": -1, "filename": "cloudinary-cli-0.2.3.1.tar.gz", "has_sig": false, "md5_digest": "0b2dc4a581c965035bc428c4aec3554e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16386, "upload_time": "2019-04-13T23:04:27", "url": "https://files.pythonhosted.org/packages/c9/4b/cbc743255fde898c682e2b5df643c256ecff23adfd9f9cbf6d72b9b20145/cloudinary-cli-0.2.3.1.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "a75c1465bdf75e082ecceab99640c065", "sha256": "92feaae9738594ed5a253a7eee6ce5556441dcb21aa2f62de0ac05b28674661a" }, "downloads": -1, "filename": "cloudinary-cli-0.2.4.tar.gz", "has_sig": false, "md5_digest": "a75c1465bdf75e082ecceab99640c065", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16519, "upload_time": "2019-05-29T00:08:21", "url": "https://files.pythonhosted.org/packages/20/47/df79091b1316fd37b4485cfbfb2044bd07cbbe3084c449b3f7178e01c0f6/cloudinary-cli-0.2.4.tar.gz" } ], "0.2.4.1": [ { "comment_text": "", "digests": { "md5": "a25e025ff83f667bc7cba8b5496f9c11", "sha256": "a539635dc02593799618fc3945ead8e9bcd69d2bc80eb096ac179aa5aaa380de" }, "downloads": -1, "filename": "cloudinary-cli-0.2.4.1.tar.gz", "has_sig": false, "md5_digest": "a25e025ff83f667bc7cba8b5496f9c11", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16689, "upload_time": "2019-05-29T02:07:19", "url": "https://files.pythonhosted.org/packages/da/f0/2743d184797753d71d9c2d1ad1775b9431d41e2b08d7a7e9aeaf3e483d43/cloudinary-cli-0.2.4.1.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "59e3beb710eb2ac9b53fc2e616cdcc7e", "sha256": "6f51616c97c52fffa9ea6667646706f4648cb9f4229cbfb46f9fa279b77264e1" }, "downloads": -1, "filename": "cloudinary-cli-0.3.0.tar.gz", "has_sig": false, "md5_digest": "59e3beb710eb2ac9b53fc2e616cdcc7e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18409, "upload_time": "2019-08-22T02:46:00", "url": "https://files.pythonhosted.org/packages/4a/85/c96d4d542cdea51f12f5dd9ffdac061ed2bd939ef75c05cce129274963d3/cloudinary-cli-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "769c0dc8c24165d634c2eefb228afd6d", "sha256": "11087bfed87e96b0b98a2b4bacec9e5954cee106f2b980f90221a2f10f8a621b" }, "downloads": -1, "filename": "cloudinary-cli-0.3.1.tar.gz", "has_sig": false, "md5_digest": "769c0dc8c24165d634c2eefb228afd6d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18956, "upload_time": "2019-10-06T22:11:19", "url": "https://files.pythonhosted.org/packages/a7/9d/db07b2499c6fc6dca0eeb45c15ad2ec4043de87aa066bce62cac5a030c37/cloudinary-cli-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "b9c0f095f487159bda1301dabbf8d0be", "sha256": "3812cf37f7f9fec3ab56b8b06fc18da8899fefb2d3eccc94de6fa38008f5f144" }, "downloads": -1, "filename": "cloudinary-cli-0.3.2.tar.gz", "has_sig": false, "md5_digest": "b9c0f095f487159bda1301dabbf8d0be", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18962, "upload_time": "2019-10-16T21:43:02", "url": "https://files.pythonhosted.org/packages/94/30/665eb873d806258b438e6a26307281b43ad497f10a372345dfa524003d6a/cloudinary-cli-0.3.2.tar.gz" } ], "0.3.3": [ { "comment_text": "", "digests": { "md5": "a25c5d312426959dd24b8ffc6f87400d", "sha256": "13e2a2fac9d0ef1795562d38f59a5d45d437d95e8380c00f9377bdbd2f51498a" }, "downloads": -1, "filename": "cloudinary-cli-0.3.3.tar.gz", "has_sig": false, "md5_digest": "a25c5d312426959dd24b8ffc6f87400d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18961, "upload_time": "2019-10-16T22:03:11", "url": "https://files.pythonhosted.org/packages/a6/5d/24c5569e4625398f55ed5a74f74148f8e3a63cbaf79bb4dbbb01d21e0bc2/cloudinary-cli-0.3.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a25c5d312426959dd24b8ffc6f87400d", "sha256": "13e2a2fac9d0ef1795562d38f59a5d45d437d95e8380c00f9377bdbd2f51498a" }, "downloads": -1, "filename": "cloudinary-cli-0.3.3.tar.gz", "has_sig": false, "md5_digest": "a25c5d312426959dd24b8ffc6f87400d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18961, "upload_time": "2019-10-16T22:03:11", "url": "https://files.pythonhosted.org/packages/a6/5d/24c5569e4625398f55ed5a74f74148f8e3a63cbaf79bb4dbbb01d21e0bc2/cloudinary-cli-0.3.3.tar.gz" } ] }