Merge pull request #118 from cortexapps/typer

Rewrite based on typer CLI library

Author: jeff-schnitter

.github/CODEOWNERS

@@ -5,4 +5,4 @@
 # the repo. Unless a later match takes precedence,
 # @global-owner1 and @global-owner2 will be requested for
 # review when someone opens a pull request.
-* @jeff-schnitter @rich-jay
+* @jeff-schnitter

.github/workflows/test-pr.yml

@@ -12,12 +12,8 @@ on:
 env:
   AWS_ACCOUNT_ID: ${{ secrets.AWS_ACCOUNT_ID }}
   CORTEX_API_KEY: ${{ secrets.CORTEX_API_KEY }}
-  CORTEX_API_KEY_RICH_SANDBOX: ${{ secrets.CORTEX_API_KEY_RICH_SANDBOX }}
   CORTEX_API_KEY_VIEWER: ${{ secrets.CORTEX_API_KEY_VIEWER }}
   CORTEX_BASE_URL: ${{ vars.CORTEX_BASE_URL }}
-  GH_PAT: ${{ secrets.GH_PAT }}
-  GH_WEBHOOK_SECRET: ${{ secrets.GH_WEBHOOK_SECRET }}
-  CORTEX_GH_WEBHOOK_URL: ${{ vars.CORTEX_GH_WEBHOOK_URL }}
 
 jobs:
   test:
@@ -41,6 +37,7 @@ jobs:
 
     - name: Install dependencies
       run: |
+        sudo apt update && sudo apt install just
         python -m pip install --upgrade pip
         pip install poetry poetry-audit-plugin pytest-cov pytest pytest-xdist
 
@@ -53,11 +50,6 @@ jobs:
         echo "[default]" > $HOME/.cortex/config
         echo "api_key = $CORTEX_API_KEY" >> $HOME/.cortex/config
         echo "base_url = $CORTEX_BASE_URL" >> $HOME/.cortex/config
-        echo "[rich-sandbox]" >> $HOME/.cortex/config
-        echo "api_key = $CORTEX_API_KEY_RICH_SANDBOX" >> $HOME/.cortex/config
-        pwd
-        ls -l $HOME/.cortex
-        cat $HOME/.cortex/config
       shell: bash
 
     - name: Install package
@@ -67,4 +59,4 @@ jobs:
 
     - name: Test with pytest
       run: |
-        make all-cli
+        just test-all

.gitignore

@@ -10,3 +10,7 @@ coverage.json
 .github/workflows/test.yml
 .export
 report.html
+import.html
+report*.html
+.load-data-done
+

HISTORY.md

@@ -1,6 +1,26 @@
 Release History
 ===============
 
+1.0.0 (2025-06-13)
+------------------
+
+**Improvements**
+- A complete re-write centered around the [typer library](https://typer.tiangolo.com/) and better code modularization
+- Added sub-commands:
+  - api-keys
+  - custom-metrics
+  - initiatives
+  - workflows
+- Removed sub-commands:
+  - team hieararchies
+- added `--table` and `--csv` options to list commands
+
+**Breaking Changes**
+- custom-events -i timestamp changed to -ts timestamp
+- plugins `get` command changed to `list` 
+- plugins `get-by-tag` subcommand changed to `get`
+- `resource-definitions` command changed to `entity-types`
+
 0.27.0 (2025-01-04)
 ------------------
 

Justfile

@@ -0,0 +1,35 @@
+cortex_cli := 'poetry run cortex'
+pytest := 'PYTHONPATH=. poetry run pytest -rA'
+
+export CORTEX_API_KEY := env('CORTEX_API_KEY')
+export CORTEX_BASE_URL := env('CORTEX_BASE_URL', "https://api.getcortexapp.com")
+export CORTEX_API_KEY_VIEWER := env('CORTEX_API_KEY_VIEWER')
+
+help:
+   @just -l
+
+_setup:
+   @if [ -f .coverage ]; then rm .coverage; fi
+
+# Run all tests
+test-all: _setup test-parallel test-serial
+
+# Run tests that can run in parallel
+test-parallel: test-import
+   {{pytest}} -n auto -m "not setup and not serial" --html=report-parallel.html --self-contained-html --cov=cortexapps_cli --cov-append --cov-report term-missing tests
+
+# Run all tests serially - helpful to see if any tests seem to be hanging
+_test-all-individual:  test-import
+   {{pytest}} --html=report-all-invidual.html --self-contained-html --cov=cortexapps_cli --cov-append --cov-report term-missing tests
+
+# Run tests that have to run sequentially
+test-serial: test-import
+   {{pytest}} -n auto -m "serial" --html=report-serial.html --self-contained-html --cov=cortexapps_cli --cov-append --cov-report term-missing tests
+
+# Run import test, a pre-requisite for any tests that rely on test data.
+test-import:
+   {{pytest}} tests/test_import.py --cov=cortexapps_cli  --cov-report=
+
+# Run a single test, ie: just test tests/test_catalog.py
+test testname:
+   {{pytest}} {{testname}}