cloudinary-cli 1.17.0__tar.gz → 1.18.0__tar.gz

{cloudinary_cli-1.17.0 → cloudinary_cli-1.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cloudinary-cli
-Version: 1.17.0
+Version: 1.18.0
 Summary: A command line interface for Cloudinary with full API support
 Home-page: https://github.com/cloudinary/cloudinary-cli
 Author: Cloudinary, Brian Luk
@@ -13,7 +13,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: cloudinary>=1.46.3
+Requires-Dist: cloudinary>=1.47.0
 Requires-Dist: pygments
 Requires-Dist: jinja2
 Requires-Dist: click
@@ -181,6 +181,7 @@ cld logout         # Revokes and removes a saved OAuth login.
 cld search --help  # Shows usage for the Search API.
 cld admin          # Lists Admin API methods.
 cld uploader       # Lists Upload API methods.
+cld collections    # Lists Collections API methods.
 cld agent signup   # For AI agents: creates a Cloudinary account on behalf of a human.
 cld agent cloud    # For AI agents: creates a temporary cloud that works immediately.
 ```
@@ -262,6 +263,32 @@ cld admin transformation my_new_transformation
 
 _**Note:** you can omit 'admin' from the command when calling an Admin API method._
 
+## Collections API
+
+Enables you to run any methods that can be called through the collections API, to organize assets into collections and share them through public pages.
+
+You can find documentation for each of the Collections API methods at [https://cloudinary.com/documentation/collections_api](https://cloudinary.com/documentation/collections_api).
+
+The basic syntax using the Collections API is as follows:
+
+```
+cld [cli options] collections [command options] [method] [method parameters]
+```
+
+Example: create a collection, add an asset to it and publish it as a public page:
+
+```
+cld collections create_collection "Summer campaign" -o description "Campaign assets"
+cld collections add_collection_assets <collection_id> '["<asset_id>"]'
+cld collections create_collection_public_page <collection_id>
+```
+
+Create a dynamic collection from a search expression:
+
+```
+cld collections create_collection "Summer images" -o type dynamic -O configuration '{"expression": "tags=summer"}'
+```
+
 ## Search API
 
 Runs the admin API search method, allowing you to use a Lucene query string as the expression.

cloudinary_cli-1.17.0/cloudinary_cli.egg-info/PKG-INFO → cloudinary_cli-1.18.0/README.md

@@ -1,29 +1,3 @@
-Metadata-Version: 2.1
-Name: cloudinary-cli
-Version: 1.17.0
-Summary: A command line interface for Cloudinary with full API support
-Home-page: https://github.com/cloudinary/cloudinary-cli
-Author: Cloudinary, Brian Luk
-Author-email: info@cloudinary.com, lukitsbrian@gmail.com
-License: MIT
-Keywords: cloudinary cli pycloudinary image video digital asset management command line interface transformation friendly easy flexible
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8.0
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: cloudinary>=1.46.3
-Requires-Dist: pygments
-Requires-Dist: jinja2
-Requires-Dist: click
-Requires-Dist: click-log
-Requires-Dist: filelock
-Requires-Dist: requests
-Requires-Dist: docstring-parser
-Requires-Dist: urllib3>=2.2.2
-Requires-Dist: zipp>=3.19.1
-
 [![Build Status](https://app.travis-ci.com/cloudinary/cloudinary-cli.svg)](https://app.travis-ci.com/cloudinary/cloudinary-cli)
 [![PyPI Downloads](https://img.shields.io/pypi/dm/cloudinary-cli.svg)](https://pypistats.org/packages/cloudinary-cli)
 [![PyPI License](https://img.shields.io/pypi/l/cloudinary-cli.svg)](LICENSE)
@@ -181,6 +155,7 @@ cld logout         # Revokes and removes a saved OAuth login.
 cld search --help  # Shows usage for the Search API.
 cld admin          # Lists Admin API methods.
 cld uploader       # Lists Upload API methods.
+cld collections    # Lists Collections API methods.
 cld agent signup   # For AI agents: creates a Cloudinary account on behalf of a human.
 cld agent cloud    # For AI agents: creates a temporary cloud that works immediately.
 ```
@@ -262,6 +237,32 @@ cld admin transformation my_new_transformation
 
 _**Note:** you can omit 'admin' from the command when calling an Admin API method._
 
+## Collections API
+
+Enables you to run any methods that can be called through the collections API, to organize assets into collections and share them through public pages.
+
+You can find documentation for each of the Collections API methods at [https://cloudinary.com/documentation/collections_api](https://cloudinary.com/documentation/collections_api).
+
+The basic syntax using the Collections API is as follows:
+
+```
+cld [cli options] collections [command options] [method] [method parameters]
+```
+
+Example: create a collection, add an asset to it and publish it as a public page:
+
+```
+cld collections create_collection "Summer campaign" -o description "Campaign assets"
+cld collections add_collection_assets <collection_id> '["<asset_id>"]'
+cld collections create_collection_public_page <collection_id>
+```
+
+Create a dynamic collection from a search expression:
+
+```
+cld collections create_collection "Summer images" -o type dynamic -O configuration '{"expression": "tags=summer"}'
+```
+
 ## Search API
 
 Runs the admin API search method, allowing you to use a Lucene query string as the expression.

{cloudinary_cli-1.17.0 → cloudinary_cli-1.18.0}/cloudinary_cli/core/__init__.py

@@ -3,6 +3,7 @@ import click
 from cloudinary_cli.core.admin import admin
 from cloudinary_cli.core.agent import agent_group
 from cloudinary_cli.core.auth import login, logout
+from cloudinary_cli.core.collections import collections
 from cloudinary_cli.core.config import config_command
 from cloudinary_cli.core.search import search, search_folders
 from cloudinary_cli.core.uploader import uploader
@@ -22,6 +23,7 @@ commands = [
     admin,
     uploader,
     provisioning,
+    collections,
     url,
     utils
 ]

cloudinary_cli-1.18.0/cloudinary_cli/core/collections.py

@@ -0,0 +1,29 @@
+from click import command, argument, option
+import cloudinary.collections
+
+from cloudinary_cli.utils.api_utils import handle_api_command
+
+
+@command("collections",
+         short_help="Run any methods that can be called through the collections API.",
+         help="""\b
+Run any methods that can be called through the collections API.
+Format: cld <cli options> collections <command options> <method> <method parameters>
+\te.g. cld collections create_collection "Summer campaign" -o description "Campaign assets"
+\t      OR
+\t    cld collections add_collection_assets <collection_id> '["<asset_id>"]'
+""")
+@argument("params", nargs=-1)
+@option("-o", "--optional_parameter", multiple=True, nargs=2,
+        help="Pass an optional parameter as a string, with no parsing. e.g. -o query summer")
+@option("-O", "--optional_parameter_parsed", multiple=True, nargs=2,
+        help="Pass an optional parameter and parse its value as JSON or a boolean. "
+             "e.g. -O configuration '{\"expression\": \"tags=summer\"}'")
+@option("-ls", "--ls", is_flag=True, help="List all available methods in the Collections API.")
+@option("--save", nargs=1, help="Save output to a file.")
+@option("-d", "--doc", is_flag=True, help="Open the Collections API reference in a browser.")
+def collections(params, optional_parameter, optional_parameter_parsed, ls, save, doc):
+    return handle_api_command(params, optional_parameter, optional_parameter_parsed, ls, save, doc,
+                              doc_url="https://cloudinary.com/documentation/collections_api",
+                              api_instance=cloudinary.collections,
+                              api_name="collections")

{cloudinary_cli-1.17.0 → cloudinary_cli-1.18.0}/cloudinary_cli/utils/utils.py

@@ -22,7 +22,8 @@ from cloudinary.utils import build_array
 
 not_callable = ('is_appengine_sandbox', 'call_tags_api', 'call_context_api', 'call_cacheable_api', 'call_api',
                 'call_metadata_api', 'call_json_api', 'only', 'transformation_string', 'account_config',
-                'reset_config', 'upload_large_part', 'upload_image', 'upload_resource', 'build_eager')
+                'reset_config', 'upload_large_part', 'upload_image', 'upload_resource', 'build_eager',
+                'base64url_decode')
 
 BLOCK_SIZE = 65536
 

cloudinary_cli-1.18.0/cloudinary_cli/version.py

@@ -0,0 +1 @@
+__version__ = "1.18.0"

cloudinary_cli-1.17.0/README.md → cloudinary_cli-1.18.0/cloudinary_cli.egg-info/PKG-INFO

@@ -1,3 +1,29 @@
+Metadata-Version: 2.1
+Name: cloudinary-cli
+Version: 1.18.0
+Summary: A command line interface for Cloudinary with full API support
+Home-page: https://github.com/cloudinary/cloudinary-cli
+Author: Cloudinary, Brian Luk
+Author-email: info@cloudinary.com, lukitsbrian@gmail.com
+License: MIT
+Keywords: cloudinary cli pycloudinary image video digital asset management command line interface transformation friendly easy flexible
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cloudinary>=1.47.0
+Requires-Dist: pygments
+Requires-Dist: jinja2
+Requires-Dist: click
+Requires-Dist: click-log
+Requires-Dist: filelock
+Requires-Dist: requests
+Requires-Dist: docstring-parser
+Requires-Dist: urllib3>=2.2.2
+Requires-Dist: zipp>=3.19.1
+
 [![Build Status](https://app.travis-ci.com/cloudinary/cloudinary-cli.svg)](https://app.travis-ci.com/cloudinary/cloudinary-cli)
 [![PyPI Downloads](https://img.shields.io/pypi/dm/cloudinary-cli.svg)](https://pypistats.org/packages/cloudinary-cli)
 [![PyPI License](https://img.shields.io/pypi/l/cloudinary-cli.svg)](LICENSE)
@@ -155,6 +181,7 @@ cld logout         # Revokes and removes a saved OAuth login.
 cld search --help  # Shows usage for the Search API.
 cld admin          # Lists Admin API methods.
 cld uploader       # Lists Upload API methods.
+cld collections    # Lists Collections API methods.
 cld agent signup   # For AI agents: creates a Cloudinary account on behalf of a human.
 cld agent cloud    # For AI agents: creates a temporary cloud that works immediately.
 ```
@@ -236,6 +263,32 @@ cld admin transformation my_new_transformation
 
 _**Note:** you can omit 'admin' from the command when calling an Admin API method._
 
+## Collections API
+
+Enables you to run any methods that can be called through the collections API, to organize assets into collections and share them through public pages.
+
+You can find documentation for each of the Collections API methods at [https://cloudinary.com/documentation/collections_api](https://cloudinary.com/documentation/collections_api).
+
+The basic syntax using the Collections API is as follows:
+
+```
+cld [cli options] collections [command options] [method] [method parameters]
+```
+
+Example: create a collection, add an asset to it and publish it as a public page:
+
+```
+cld collections create_collection "Summer campaign" -o description "Campaign assets"
+cld collections add_collection_assets <collection_id> '["<asset_id>"]'
+cld collections create_collection_public_page <collection_id>
+```
+
+Create a dynamic collection from a search expression:
+
+```
+cld collections create_collection "Summer images" -o type dynamic -O configuration '{"expression": "tags=summer"}'
+```
+
 ## Search API
 
 Runs the admin API search method, allowing you to use a Lucene query string as the expression.

{cloudinary_cli-1.17.0 → cloudinary_cli-1.18.0}/cloudinary_cli.egg-info/SOURCES.txt

@@ -26,6 +26,7 @@ cloudinary_cli/core/__init__.py
 cloudinary_cli/core/admin.py
 cloudinary_cli/core/agent.py
 cloudinary_cli/core/auth.py
+cloudinary_cli/core/collections.py
 cloudinary_cli/core/config.py
 cloudinary_cli/core/overrides.py
 cloudinary_cli/core/provisioning.py

{cloudinary_cli-1.17.0 → cloudinary_cli-1.18.0}/cloudinary_cli.egg-info/requires.txt

@@ -1,4 +1,4 @@
-cloudinary>=1.46.3
+cloudinary>=1.47.0
 pygments
 jinja2
 click

{cloudinary_cli-1.17.0 → cloudinary_cli-1.18.0}/requirements.txt

@@ -1,4 +1,4 @@
-cloudinary>=1.46.3
+cloudinary>=1.47.0
 pygments
 jinja2
 click

{cloudinary_cli-1.17.0 → cloudinary_cli-1.18.0}/test/test_cli.py

@@ -16,6 +16,7 @@ class TestCLI(unittest.TestCase):
     COMMANDS = [
         'admin',
         'agent',
+        'collections',
         'config',
         'login',
         'logout',

{cloudinary_cli-1.17.0 → cloudinary_cli-1.18.0}/test/test_cli_api.py

@@ -45,6 +45,23 @@ class TestCLIApi(unittest.TestCase):
         self.assertEqual(0, result.exit_code, result.output)
         self.assertIn('"foo": "bar"', result.output)
 
+    @unittest.skipUnless(CONFIG_PRESENT, REQUIRES_CONFIG)
+    @patch(URLLIB3_REQUEST)
+    def test_collections(self, mocker):
+        mocker.return_value = API_MOCK_RESPONSE
+        result = self.runner.invoke(cli, ['collections', 'add_collection_assets', 'col1', '["a1", "a2"]'])
+
+        self.assertEqual(0, result.exit_code, result.output)
+        self.assertIn('"foo": "bar"', result.output)
+        self.assertIn('/collections/col1/assets', mocker.call_args[1]['url'])
+
+    def test_collections_ls(self):
+        result = self.runner.invoke(cli, ['collections', '-ls'])
+
+        self.assertEqual(0, result.exit_code, result.output)
+        self.assertIn('create_collection', result.output)
+        self.assertNotIn('base64url_decode', result.output)
+
 
 class TestDestructiveBulkConfirmation(unittest.TestCase):
     runner = CliRunner()

cloudinary_cli-1.17.0/cloudinary_cli/version.py

@@ -1 +0,0 @@
-__version__ = "1.17.0"