cortexapps-cli 0.21.0__tar.gz → 0.23.0__tar.gz

{cortexapps_cli-0.21.0 → cortexapps_cli-0.23.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cortexapps-cli
-Version: 0.21.0
+Version: 0.23.0
 Summary: Command Line Interface for cortexapps
 License: MIT
 Author: Cortex Apps
@@ -57,34 +57,10 @@ Using a python virtual environment:
 homebrew
 ----------------------
 
-The package will be published to homebrew in the future, but we need your help!
-
-In order to be accepted to `homebrew-core <https://github.com/Homebrew/homebrew-core>`_, a repository has to be 'notable'. This
-is determined by running an `audit <https://docs.brew.sh/Adding-Software-to-Homebrew#testing-and-auditing-the-formula>`_
-of the homebrew formula.  Currently, this results in the following:
-
-.. code-block::
-
-  brew audit --strict --new-formula --online cortexapps-cli
-  cortexapps-cli
-    * GitHub repository not notable enough (<30 forks, <30 watchers and <75 stars)
-  Error: 1 problem in 1 formula detected.
-
-Please help us by watching and starring https://github.com/cortexapps/cli.  Once we're 'notable', we'll
-throw a small party for ourselves and then submit a PR to homebrew-core. 
- 
-Workaround for homebrew installation
-------------------------------------
-
-This is a temporary solution until we reach 'notable' status and get the formula added to `homebrew-core <https://github.com/Homebrew/homebrew-core>`_.
-
-Run the following commands to download the homebrew formula from this repo into your local homebrew tap:
-
 .. code:: bash
-                                                                                                          
-  curl -L -H "Accept: application/vnd.github.VERSION.raw" -o $(brew --repository)/Library/Taps/homebrew/homebrew-core/Formula/c/cortexapps-cli.rb https://api.github.com/repos/cortexapps/cli/contents/homebrew/cortexapps-cli.rb
-  HOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source cortexapps-cli
 
+  brew tap cortexapps/tap
+  brew install cortexapps-cli
 
 ===================
  Usage
@@ -400,6 +376,82 @@ assigns the environment attribute to the correct value and invokes the CLI with
      cat /tmp/deploys.json | jq ".deployments[] | select (.uuid==\"${uuid}\") | del(.uuid) | .environment = \"PyPI.org\"" | cortex deploys update-by-uuid -t cli -u ${uuid} -f-
   done
 
+-----------------------------------------------------------------------------
+Create a backup of all scorecards
+-----------------------------------------------------------------------------
+
+.. code:: bash
+    
+   for tag in `cortex scorecards list | jq -r ".scorecards[].tag"`
+   do
+      echo "backing up: ${tag}"
+      cortex scorecards descriptor -t ${tag} > ${tag}.yaml
+   done
+
+-----------------------------------------------------------------------------
+Create a copy of all scorecards in draft mode
+-----------------------------------------------------------------------------
+
+This recipe creates a draft scorecard for all existing scorecards.  It creates each scorecard with a suffix for the scorecard tag of "-draft"
+and it appends " Draft" to the end of the existing title.
+
+.. code:: bash
+    
+   for tag in `cortex scorecards list | jq -r ".scorecards[].tag"`
+   do
+      cortex scorecards descriptor -t ${tag} | yq '.draft = true | .tag += "-draft" | .name += " Draft"' | cortex scorecards create -f-
+   done
+
+-----------------------------------------------------------------------------
+Replace scorecards with draft versions and delete the draft versions
+-----------------------------------------------------------------------------
+
+This recipe is a companion to the above recipe.  This recipe will replace the versions from
+which the drafts were created and delete the drafts.
+
+.. code:: bash
+    
+   for tag in `cortex scorecards list -s | jq -r ".scorecards[].tag" | grep "\-draft$"`
+   do
+      cortex scorecards descriptor -t ${tag} | yq '.draft = false | .tag |= sub("-draft","") | .name |= sub(" Draft", "")' | cortex scorecards create -f- && cortex scorecards delete -t ${tag}
+   done
+
+-----------------------------------------------------------------------------
+Get draft scorecards, change draft to false and save on disk
+-----------------------------------------------------------------------------
+
+This recipe is similar to the one above, but it does not create a new scorecard in Cortex.  Rather, it makes the changes and saves to a file.
+
+.. code:: bash
+    
+   for tag in `cortex scorecards list -s | jq -r ".scorecards[].tag" | grep "\-draft$"`
+   do
+      cortex scorecards descriptor -t ${tag} | yq '.draft = false | .tag |= sub("-draft","") | .name |= sub(" Draft", "")' > ${tag}.yaml
+   done
+
+-----------------------------------------------------------------------------
+Delete all draft scorecards
+-----------------------------------------------------------------------------
+
+WARNING: This recipe will delete all draft scorecards.  
+
+.. code:: bash
+    
+   for tag in `cortex scorecards list -s | jq -r ".scorecards[].tag"`
+   do
+      cortex scorecards delete -t ${tag}
+   done
+
+If you only want to delete some drafts, for example if you followed a recipe that creates draft versions of all existing scorecards, you 
+will likely want to run this instead:
+
+.. code:: bash
+    
+   for tag in `cortex scorecards list -s | jq -r ".scorecards[].tag" | grep "\-draft$"`
+   do
+      cortex scorecards delete -t ${tag}
+   done
+
 -----------------------------------------------------------------------------
 Compare scorecard scores and levels for two scorecards
 -----------------------------------------------------------------------------

{cortexapps_cli-0.21.0 → cortexapps_cli-0.23.0}/README.rst

@@ -36,34 +36,10 @@ Using a python virtual environment:
 homebrew
 ----------------------
 
-The package will be published to homebrew in the future, but we need your help!
-
-In order to be accepted to `homebrew-core <https://github.com/Homebrew/homebrew-core>`_, a repository has to be 'notable'. This
-is determined by running an `audit <https://docs.brew.sh/Adding-Software-to-Homebrew#testing-and-auditing-the-formula>`_
-of the homebrew formula.  Currently, this results in the following:
-
-.. code-block::
-
-  brew audit --strict --new-formula --online cortexapps-cli
-  cortexapps-cli
-    * GitHub repository not notable enough (<30 forks, <30 watchers and <75 stars)
-  Error: 1 problem in 1 formula detected.
-
-Please help us by watching and starring https://github.com/cortexapps/cli.  Once we're 'notable', we'll
-throw a small party for ourselves and then submit a PR to homebrew-core. 
- 
-Workaround for homebrew installation
-------------------------------------
-
-This is a temporary solution until we reach 'notable' status and get the formula added to `homebrew-core <https://github.com/Homebrew/homebrew-core>`_.
-
-Run the following commands to download the homebrew formula from this repo into your local homebrew tap:
-
 .. code:: bash
-                                                                                                          
-  curl -L -H "Accept: application/vnd.github.VERSION.raw" -o $(brew --repository)/Library/Taps/homebrew/homebrew-core/Formula/c/cortexapps-cli.rb https://api.github.com/repos/cortexapps/cli/contents/homebrew/cortexapps-cli.rb
-  HOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source cortexapps-cli
 
+  brew tap cortexapps/tap
+  brew install cortexapps-cli
 
 ===================
  Usage
@@ -379,6 +355,82 @@ assigns the environment attribute to the correct value and invokes the CLI with
      cat /tmp/deploys.json | jq ".deployments[] | select (.uuid==\"${uuid}\") | del(.uuid) | .environment = \"PyPI.org\"" | cortex deploys update-by-uuid -t cli -u ${uuid} -f-
   done
 
+-----------------------------------------------------------------------------
+Create a backup of all scorecards
+-----------------------------------------------------------------------------
+
+.. code:: bash
+    
+   for tag in `cortex scorecards list | jq -r ".scorecards[].tag"`
+   do
+      echo "backing up: ${tag}"
+      cortex scorecards descriptor -t ${tag} > ${tag}.yaml
+   done
+
+-----------------------------------------------------------------------------
+Create a copy of all scorecards in draft mode
+-----------------------------------------------------------------------------
+
+This recipe creates a draft scorecard for all existing scorecards.  It creates each scorecard with a suffix for the scorecard tag of "-draft"
+and it appends " Draft" to the end of the existing title.
+
+.. code:: bash
+    
+   for tag in `cortex scorecards list | jq -r ".scorecards[].tag"`
+   do
+      cortex scorecards descriptor -t ${tag} | yq '.draft = true | .tag += "-draft" | .name += " Draft"' | cortex scorecards create -f-
+   done
+
+-----------------------------------------------------------------------------
+Replace scorecards with draft versions and delete the draft versions
+-----------------------------------------------------------------------------
+
+This recipe is a companion to the above recipe.  This recipe will replace the versions from
+which the drafts were created and delete the drafts.
+
+.. code:: bash
+    
+   for tag in `cortex scorecards list -s | jq -r ".scorecards[].tag" | grep "\-draft$"`
+   do
+      cortex scorecards descriptor -t ${tag} | yq '.draft = false | .tag |= sub("-draft","") | .name |= sub(" Draft", "")' | cortex scorecards create -f- && cortex scorecards delete -t ${tag}
+   done
+
+-----------------------------------------------------------------------------
+Get draft scorecards, change draft to false and save on disk
+-----------------------------------------------------------------------------
+
+This recipe is similar to the one above, but it does not create a new scorecard in Cortex.  Rather, it makes the changes and saves to a file.
+
+.. code:: bash
+    
+   for tag in `cortex scorecards list -s | jq -r ".scorecards[].tag" | grep "\-draft$"`
+   do
+      cortex scorecards descriptor -t ${tag} | yq '.draft = false | .tag |= sub("-draft","") | .name |= sub(" Draft", "")' > ${tag}.yaml
+   done
+
+-----------------------------------------------------------------------------
+Delete all draft scorecards
+-----------------------------------------------------------------------------
+
+WARNING: This recipe will delete all draft scorecards.  
+
+.. code:: bash
+    
+   for tag in `cortex scorecards list -s | jq -r ".scorecards[].tag"`
+   do
+      cortex scorecards delete -t ${tag}
+   done
+
+If you only want to delete some drafts, for example if you followed a recipe that creates draft versions of all existing scorecards, you 
+will likely want to run this instead:
+
+.. code:: bash
+    
+   for tag in `cortex scorecards list -s | jq -r ".scorecards[].tag" | grep "\-draft$"`
+   do
+      cortex scorecards delete -t ${tag}
+   done
+
 -----------------------------------------------------------------------------
 Compare scorecard scores and levels for two scorecards
 -----------------------------------------------------------------------------

{cortexapps_cli-0.21.0 → cortexapps_cli-0.23.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "cortexapps-cli"
 # version will be incremented via command line as part of github actions build
-version = "0.21.0"
+version = "0.23.0"
 description = "Command Line Interface for cortexapps"
 license = "MIT"
 authors = [