apigeecli 0.53.4__tar.gz → 0.53.6__tar.gz

{apigeecli-0.53.4/apigeecli.egg-info → apigeecli-0.53.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: apigeecli
-Version: 0.53.4
+Version: 0.53.6
 Summary: The Apigee Edge command-line interface is an unofficial Python command-line tool built to simplify and automate Apigee Edge API usage, with support for SSO, MFA, and basic authentication.
 Home-page: https://github.com/darumatic/apigee-cli
 Author: Matthew Delotavo
@@ -23,7 +23,7 @@ License-File: NOTICE
 apigee-cli
 ==========
 
-|License| |Python version| |Downloads|
+|Python version| |Downloads| |License|
 
 .. warning::
 
@@ -31,15 +31,15 @@ apigee-cli
 
 The Apigee Edge command-line interface is an unofficial Python command-line tool built to simplify and automate Apigee Edge API usage, with support for SSO, MFA, and basic authentication.
 
-Initially developed for Darumatic clients, this project remains available as a working proof of concept, proven reliable in production CI/CD pipelines. The custom plugins feature will remain functional even if Apigee Edge APIs stop working.
+Initially developed for Darumatic clients, this project remains available as a functional proof of concept and has proven reliable in production CI/CD pipelines. I do not plan to maintain this public version, but you're welcome to explore and learn from the code. The custom plugins feature will continue to work even if the Apigee Edge APIs become unavailable.
 
-I have created private forks for clients, where I continued to add features, fixes, and unit tests. However, I do not intend to maintain this public version. Feel free to explore and learn from the code.
+*If you’re up for a challenge, try updating the code to work with Apigee X*
 
-If you’re up for a challenge, try updating the code to work with Apigee X :)
+-----------------------------------------
+Why use this instead of the official tool
+-----------------------------------------
 
-.. note::
-
-   **apigee-cli** is highly experimental and is not affiliated with Apigee or Google.
+The `official Apigee CLI`_ is powerful and may suit your needs. However, I built this version to better support our CI/CD processes, self-service operations, and DevOps workflows that are difficult to manage with the official tool.
 
 ------------
 Installation
@@ -126,25 +126,6 @@ Run the following command to get a list of API proxies in your ``default`` Apige
     $ apigee apis list
     ["helloworld", "oauth"]
 
---------------------
-Why does this exist?
---------------------
-
-It is intended for general administrative use from your shell, as a package for developers,
-and to support automation for common development tasks, such as test automation
-or Continuous Integration/Continuous Deployment (CI/CD).
-
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-When to use this over the official tool
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Apigee Corporation maintains their own `fully-featured CLI`_ for the Apigee Management API
-that can be used as an SDK to orchestrate tasks and may be more than suitable for your needs.
-
-We built and use the Apigee CLI to implement and distribute features that allow our clients
-to manage CI/CD, perform self-service operations and promote our DevOps workflows
-which are difficult to perform using official tools.
-
 -------------
 Running Tests
 -------------
@@ -182,10 +163,11 @@ For further questions, feel free to contact us at hello@darumatic.com.
 ----------
 Disclaimer
 ----------
-This is not an officially supported Google product.
+
+This tool is not affiliated with Apigee or Google and is highly experimental.
 
 
-.. _`fully-featured CLI`: https://github.com/apigee/apigeetool-node
+.. _`official Apigee CLI`: https://github.com/apigee/apigeetool-node
 
 .. |Upload Python Package badge| image:: https://github.com/mdelotavo/apigee-cli/workflows/Upload%20Python%20Package/badge.svg
     :target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Upload+Python+Package%22

{apigeecli-0.53.4 → apigeecli-0.53.6}/README.rst

@@ -2,7 +2,7 @@
 apigee-cli
 ==========
 
-|License| |Python version| |Downloads|
+|Python version| |Downloads| |License|
 
 .. warning::
 
@@ -10,15 +10,15 @@ apigee-cli
 
 The Apigee Edge command-line interface is an unofficial Python command-line tool built to simplify and automate Apigee Edge API usage, with support for SSO, MFA, and basic authentication.
 
-Initially developed for Darumatic clients, this project remains available as a working proof of concept, proven reliable in production CI/CD pipelines. The custom plugins feature will remain functional even if Apigee Edge APIs stop working.
+Initially developed for Darumatic clients, this project remains available as a functional proof of concept and has proven reliable in production CI/CD pipelines. I do not plan to maintain this public version, but you're welcome to explore and learn from the code. The custom plugins feature will continue to work even if the Apigee Edge APIs become unavailable.
 
-I have created private forks for clients, where I continued to add features, fixes, and unit tests. However, I do not intend to maintain this public version. Feel free to explore and learn from the code.
+*If you’re up for a challenge, try updating the code to work with Apigee X*
 
-If you’re up for a challenge, try updating the code to work with Apigee X :)
+-----------------------------------------
+Why use this instead of the official tool
+-----------------------------------------
 
-.. note::
-
-   **apigee-cli** is highly experimental and is not affiliated with Apigee or Google.
+The `official Apigee CLI`_ is powerful and may suit your needs. However, I built this version to better support our CI/CD processes, self-service operations, and DevOps workflows that are difficult to manage with the official tool.
 
 ------------
 Installation
@@ -105,25 +105,6 @@ Run the following command to get a list of API proxies in your ``default`` Apige
     $ apigee apis list
     ["helloworld", "oauth"]
 
---------------------
-Why does this exist?
---------------------
-
-It is intended for general administrative use from your shell, as a package for developers,
-and to support automation for common development tasks, such as test automation
-or Continuous Integration/Continuous Deployment (CI/CD).
-
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-When to use this over the official tool
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Apigee Corporation maintains their own `fully-featured CLI`_ for the Apigee Management API
-that can be used as an SDK to orchestrate tasks and may be more than suitable for your needs.
-
-We built and use the Apigee CLI to implement and distribute features that allow our clients
-to manage CI/CD, perform self-service operations and promote our DevOps workflows
-which are difficult to perform using official tools.
-
 -------------
 Running Tests
 -------------
@@ -161,10 +142,11 @@ For further questions, feel free to contact us at hello@darumatic.com.
 ----------
 Disclaimer
 ----------
-This is not an officially supported Google product.
+
+This tool is not affiliated with Apigee or Google and is highly experimental.
 
 
-.. _`fully-featured CLI`: https://github.com/apigee/apigeetool-node
+.. _`official Apigee CLI`: https://github.com/apigee/apigeetool-node
 
 .. |Upload Python Package badge| image:: https://github.com/mdelotavo/apigee-cli/workflows/Upload%20Python%20Package/badge.svg
     :target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Upload+Python+Package%22

{apigeecli-0.53.4 → apigeecli-0.53.6}/apigee/__init__.py

@@ -6,7 +6,7 @@ from apigee import utils_init
 
 APP = "apigeecli"
 CMD = "apigee"
-__version__ = "0.53.4"
+__version__ = "0.53.6"
 description = "The Apigee Edge command-line interface is an unofficial Python command-line tool built to simplify and automate Apigee Edge API usage, with support for SSO, MFA, and basic authentication."
 long_description = """This tool is no longer actively maintained. Initially developed for Darumatic clients, this project remains available as a working proof of concept, proven reliable in production CI/CD pipelines. The custom plugins feature will remain functional even if Apigee Edge APIs stop working."""
 

{apigeecli-0.53.4 → apigeecli-0.53.6/apigeecli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: apigeecli
-Version: 0.53.4
+Version: 0.53.6
 Summary: The Apigee Edge command-line interface is an unofficial Python command-line tool built to simplify and automate Apigee Edge API usage, with support for SSO, MFA, and basic authentication.
 Home-page: https://github.com/darumatic/apigee-cli
 Author: Matthew Delotavo
@@ -23,7 +23,7 @@ License-File: NOTICE
 apigee-cli
 ==========
 
-|License| |Python version| |Downloads|
+|Python version| |Downloads| |License|
 
 .. warning::
 
@@ -31,15 +31,15 @@ apigee-cli
 
 The Apigee Edge command-line interface is an unofficial Python command-line tool built to simplify and automate Apigee Edge API usage, with support for SSO, MFA, and basic authentication.
 
-Initially developed for Darumatic clients, this project remains available as a working proof of concept, proven reliable in production CI/CD pipelines. The custom plugins feature will remain functional even if Apigee Edge APIs stop working.
+Initially developed for Darumatic clients, this project remains available as a functional proof of concept and has proven reliable in production CI/CD pipelines. I do not plan to maintain this public version, but you're welcome to explore and learn from the code. The custom plugins feature will continue to work even if the Apigee Edge APIs become unavailable.
 
-I have created private forks for clients, where I continued to add features, fixes, and unit tests. However, I do not intend to maintain this public version. Feel free to explore and learn from the code.
+*If you’re up for a challenge, try updating the code to work with Apigee X*
 
-If you’re up for a challenge, try updating the code to work with Apigee X :)
+-----------------------------------------
+Why use this instead of the official tool
+-----------------------------------------
 
-.. note::
-
-   **apigee-cli** is highly experimental and is not affiliated with Apigee or Google.
+The `official Apigee CLI`_ is powerful and may suit your needs. However, I built this version to better support our CI/CD processes, self-service operations, and DevOps workflows that are difficult to manage with the official tool.
 
 ------------
 Installation
@@ -126,25 +126,6 @@ Run the following command to get a list of API proxies in your ``default`` Apige
     $ apigee apis list
     ["helloworld", "oauth"]
 
---------------------
-Why does this exist?
---------------------
-
-It is intended for general administrative use from your shell, as a package for developers,
-and to support automation for common development tasks, such as test automation
-or Continuous Integration/Continuous Deployment (CI/CD).
-
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-When to use this over the official tool
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Apigee Corporation maintains their own `fully-featured CLI`_ for the Apigee Management API
-that can be used as an SDK to orchestrate tasks and may be more than suitable for your needs.
-
-We built and use the Apigee CLI to implement and distribute features that allow our clients
-to manage CI/CD, perform self-service operations and promote our DevOps workflows
-which are difficult to perform using official tools.
-
 -------------
 Running Tests
 -------------
@@ -182,10 +163,11 @@ For further questions, feel free to contact us at hello@darumatic.com.
 ----------
 Disclaimer
 ----------
-This is not an officially supported Google product.
+
+This tool is not affiliated with Apigee or Google and is highly experimental.
 
 
-.. _`fully-featured CLI`: https://github.com/apigee/apigeetool-node
+.. _`official Apigee CLI`: https://github.com/apigee/apigeetool-node
 
 .. |Upload Python Package badge| image:: https://github.com/mdelotavo/apigee-cli/workflows/Upload%20Python%20Package/badge.svg
     :target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Upload+Python+Package%22

{apigeecli-0.53.4 → apigeecli-0.53.6}/apigeecli.egg-info/SOURCES.txt

@@ -25,7 +25,6 @@ apigee/apis/api_puller_with_dependency_extraction.py
 apigee/apis/apis.py
 apigee/apis/commands.py
 apigee/apis/deploy.py
-apigee/apis/pull.py
 apigee/apis/serializer.py
 apigee/apps/__init__.py
 apigee/apps/apps.py

apigeecli-0.53.4/apigee/apis/pull.py

@@ -1,255 +0,0 @@
-import logging
-import os
-import xml.etree.ElementTree as et
-from pathlib import Path
-
-from apigee import console
-from apigee.apis.apis import Apis
-from apigee.caches.caches import Caches
-from apigee.keyvaluemaps.keyvaluemaps import Keyvaluemaps
-from apigee.targetservers.targetservers import Targetservers
-from apigee.utils import (extract_zip, make_dirs, path_exists, paths_exist,
-                          run_func_on_dir_files, run_func_on_iterable)
-
-
-class PullApis:
-    def __init__(self, auth, org_name, revision_number, environment, work_tree=None):
-        self.auth = auth
-        self.org_name = org_name
-        self.work_tree = work_tree
-        self.revision_number = revision_number
-        self.environment = environment
-        self.keyvaluemaps_dir = "keyvaluemaps"
-        self.targetservers_dir = "targetservers"
-        self.caches_dir = "caches"
-        self._apiproxy_dir = self.work_tree
-        self.zip_file = str(Path(self.apiproxy_dir).with_suffix(".zip"))
-
-    def __call__(self, *args, **kwargs):
-        self.pull(*args, **kwargs)
-
-    @property
-    def auth(self):
-        return self._auth
-
-    @auth.setter
-    def auth(self, value):
-        self._auth = value
-
-    @property
-    def org_name(self):
-        return self._org_name
-
-    @org_name.setter
-    def org_name(self, value):
-        self._org_name = value
-
-    @property
-    def revision_number(self):
-        return self._revision_number
-
-    @revision_number.setter
-    def revision_number(self, value):
-        self._revision_number = value
-
-    @property
-    def environment(self):
-        return self._environment
-
-    @environment.setter
-    def environment(self, value):
-        self._environment = value
-
-    @property
-    def work_tree(self):
-        return self._work_tree
-
-    @work_tree.setter
-    def work_tree(self, value):
-        if value:
-            if not os.path.exists(value):
-                os.makedirs(value)
-            self._work_tree = str(Path(value).resolve())
-        else:
-            self._work_tree = os.getcwd()
-
-    @property
-    def keyvaluemaps_dir(self):
-        return self._keyvaluemaps_dir
-
-    @keyvaluemaps_dir.setter
-    def keyvaluemaps_dir(self, value):
-        self._keyvaluemaps_dir = str(Path(self.work_tree) / value / self.environment)
-
-    @property
-    def targetservers_dir(self):
-        return self._targetservers_dir
-
-    @targetservers_dir.setter
-    def targetservers_dir(self, value):
-        self._targetservers_dir = str(Path(self.work_tree) / value / self.environment)
-
-    @property
-    def caches_dir(self):
-        return self._caches_dir
-
-    @caches_dir.setter
-    def caches_dir(self, value):
-        self._caches_dir = str(Path(self.work_tree) / value / self.environment)
-
-    @property
-    def apiproxy_dir(self):
-        return self._apiproxy_dir
-
-    @apiproxy_dir.setter
-    def apiproxy_dir(self, value):
-        self._apiproxy_dir = str(Path(self.work_tree) / value)
-
-    @property
-    def zip_file(self):
-        return self._zip_file
-
-    @zip_file.setter
-    def zip_file(self, value):
-        self._zip_file = value
-
-    # def call_export_method(self, resource_type, files, environment, dependencies=[], force=True):
-    def call_export_method(self, resource_type, files, environment, force=True):
-        resource_files = getattr(self, f"get_{resource_type}_dependencies")(files)
-        # dependencies.extend(resource_files)
-        getattr(self, f"export_{resource_type}_dependencies")(
-            environment, resource_files, force=force
-        )
-        # return dependencies
-        return resource_files
-
-    def get_apiproxy_files(self, directory):
-        return run_func_on_dir_files(str(Path(directory) / "apiproxy"), lambda f: f)
-
-    def get_keyvaluemap_dependencies(self, files):
-        def _func(f, _state):
-            try:
-                root = et.parse(f).getroot()
-                if (
-                    root.tag == "KeyValueMapOperations"
-                    and root.attrib["mapIdentifier"] not in _state
-                ):
-                    _state.add(root.attrib["mapIdentifier"])
-                    return root.attrib["mapIdentifier"]
-            except Exception as e:
-                logging.warning(f"{e}; file={f}", exc_info=True)
-
-        return run_func_on_iterable(files, _func, args=(set(),))
-
-    def export_keyvaluemap_dependencies(
-        self, environment, keyvaluemaps, force=False, expc_verbosity=1
-    ):
-        make_dirs(self._keyvaluemaps_dir)
-
-        def _func(kvm):
-            kvm_file = str(Path(self._keyvaluemaps_dir) / f"{kvm}.json")
-            if not force:
-                path_exists(os.path.relpath(kvm_file))
-            resp = (
-                Keyvaluemaps(self._auth, self._org_name, kvm)
-                .get_keyvaluemap_in_an_environment(environment)
-                .text
-            )
-            console.echo(resp, expc_verbosity=1)
-            with open(kvm_file, "w") as f:
-                f.write(resp)
-
-        return run_func_on_iterable(keyvaluemaps, _func)
-
-    def get_targetserver_dependencies(self, files):
-        def _func(f, _state):
-            try:
-                root = et.parse(f).getroot()
-                for child in root.iter("Server"):
-                    if child.attrib["name"] not in _state:
-                        _state.add(child.attrib["name"])
-                        return child.attrib["name"]
-            except Exception as e:
-                logging.warning(f"{e}; file={f}", exc_info=True)
-
-        return run_func_on_iterable(files, _func, args=(set(),))
-
-    def export_targetserver_dependencies(
-        self, environment, targetservers, force=False, expc_verbosity=1
-    ):
-        make_dirs(self._targetservers_dir)
-
-        def _func(ts):
-            ts_file = str(Path(self._targetservers_dir) / f"{ts}.json")
-            if not force:
-                path_exists(os.path.relpath(ts_file))
-            resp = (
-                Targetservers(self._auth, self._org_name, ts)
-                .get_targetserver(environment)
-                .text
-            )
-            console.echo(resp, expc_verbosity=1)
-            with open(ts_file, "w") as f:
-                f.write(resp)
-
-        return run_func_on_iterable(targetservers, _func)
-
-    def get_cache_dependencies(self, files):
-        def _func(f, _state):
-            try:
-                name = et.parse(f).find(".//CacheResource").text
-                if name and name not in _state:
-                    _state.add(name)
-                    return name
-            except Exception as e:
-                logging.warning(f"{e}; file={f}", exc_info=True)
-
-        return run_func_on_iterable(files, _func, args=(set(),))
-
-    def export_cache_dependencies(
-        self, environment, caches, force=False, expc_verbosity=1
-    ):
-        make_dirs(self._caches_dir)
-
-        def _func(cache):
-            cache_file = str(Path(self._caches_dir) / f"{cache}.json")
-            if not force:
-                path_exists(os.path.relpath(cache_file))
-            resp = (
-                Caches(self._auth, self._org_name, cache)
-                .get_information_about_a_cache(environment)
-                .text
-            )
-            console.echo(resp, expc_verbosity=1)
-            with open(cache_file, "w") as f:
-                f.write(resp)
-
-        return run_func_on_iterable(caches, _func)
-
-    # def pull(self, api_name, dependencies=[], force=False, prefix=None, basepath=None):
-    def pull(self, api_name, force=False):
-        # dependencies.append(api_name)
-        make_dirs(self.work_tree)
-        self.apiproxy_dir = api_name
-        if not force:
-            paths_exist(
-                (os.path.relpath(self.zip_file), os.path.relpath(self.apiproxy_dir))
-            )
-        exported_api = Apis(self.auth, self.org_name).export_api_proxy(
-            api_name, self.revision_number, fs_write=True, output_file=self.zip_file
-        )
-        make_dirs(self.apiproxy_dir)
-        extract_zip(self.zip_file, self.apiproxy_dir)
-        os.remove(self.zip_file)
-        files = self.get_apiproxy_files(self.apiproxy_dir)
-        for resource_type in ("keyvaluemap", "targetserver", "cache"):
-            self.call_export_method(
-                # resource_type, files, self.environment, dependencies=dependencies, force=force
-                resource_type,
-                files,
-                self.environment,
-                force=force,
-            )
-        # print(dependencies)
-        # return exported_api, dependencies
-        return exported_api