release

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Release notes
+
+<!-- do not remove -->
+
+## 1.3.0
+
+Updated to include api clients and msticpy. Also adjusted build env to use python 3.11
+
+

README.md

@@ -1,16 +1,18 @@
 # SIEM Query Utils
 
+
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
 
 ## Install
 
 ``` sh
-pip install https://github.com/wagov/nbdev-squ/archive/refs/heads/main.tar.gz
+pip install https://github.com/wagov/nbdev-squ/archive/refs/tags/v1.3.0.tar.gz
 ```
 
 ## How to use
 
-***<mark style="background-color: lightblue"> Note: If you create/use a Github Codespace on any of the wagov repos, SQU_CONFIG should be configured automatically. </mark>***
+*Note: If you create/use a Github Codespace on any of the wagov repos,
+SQU_CONFIG should be configured automatically.*
 
 Before using, config needs to be loaded into `squ.core.cache`, which can
 be done automatically from json in a keyvault by setting the env var
@@ -21,7 +23,7 @@ export SQU_CONFIG="{{ keyvault }}/{{ tenantid }}"
 ```
 
 ``` python
-from nbdev_squ import api, clients
+from nbdev_squ import api
 import io, pandas
 
 # Load workspace info from datalake blob storage
@@ -46,14 +48,17 @@ print(len(api.azcli(["account", "list"])))
 # Various pre-configured api clients
 
 # RunZero
-#response = clients.runzero.get("/export/org/assets.csv", params={"search": "has_public:t AND alive:t AND (protocol:rdp OR protocol:vnc OR protocol:teamviewer OR protocol:telnet OR protocol:ftp)"})
-#runzero_assets = pandas.read_csv(io.StringIO(response.text))
+response = api.clients.runzero.get("/export/org/assets.csv", params={"search": "has_public:t AND alive:t AND (protocol:rdp OR protocol:vnc OR protocol:teamviewer OR protocol:telnet OR protocol:ftp)"})
+pandas.read_csv(io.StringIO(response.text)).head(10)
 
 # Jira
-#issues = clients.jira.jql("updated > -1d")["issues"]
+pandas.json_normalize(api.clients.jira.jql("updated > -1d")["issues"]).head(10)
 
 # AbuseIPDB
-#clients.abuseipdb.check_ip("1.1.1.1")
+api.clients.abuseipdb.check_ip("1.1.1.1")
+
+# TenableIO
+pandas.DataFrame(api.clients.tio.scans.list()).head(10)
 ```
 
 ``` python

install.sh

@@ -5,5 +5,6 @@ npm install
 npm run build
 nbdev_clean
 nbdev_export
+nbdev_readme
 nbdev_install_hooks
 

nbdev_squ/api.py

@@ -28,6 +28,7 @@ class Clients:
     """
     @cached_property
     def config(self):
+        login()
         return cache.get("config", load_config())
 
     @cached_property

nbs/01_api.ipynb

@@ -89,6 +89,7 @@
     "    \"\"\"\n",
     "    @cached_property\n",
     "    def config(self):\n",
+    "        login()\n",
     "        return cache.get(\"config\", load_config())\n",
     "\n",
     "    @cached_property\n",

nbs/index.ipynb

@@ -31,7 +31,7 @@
    "metadata": {},
    "source": [
     "```sh\n",
-    "pip install nbdev_squ\n",
+    "pip install https://github.com/wagov/nbdev-squ/archive/refs/tags/v1.3.0.tar.gz\n",
     "```"
    ]
   },
@@ -46,6 +46,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "*Note: If you create/use a Github Codespace on any of the wagov repos, SQU_CONFIG should be configured automatically.*\n",
+    "\n",
     "Before using, config needs to be loaded into `squ.core.cache`, which can be done automatically from json in a keyvault by setting the env var `SQU_CONFIG` to `\"keyvault/tenantid\"`.\n",
     "\n",
     "```bash\n",

nbs/sidebar.yml

@@ -3,5 +3,4 @@ website:
     contents:
       - index.ipynb
       - 00_core.ipynb
-      - 01_api.ipynb
-      - 02_clients.ipynb
+      - 01_api.ipynb