From f351e70fbdf72ec14f335aa74ad3e7f0bc6da5bc Mon Sep 17 00:00:00 2001
From: Christian Cleberg <hello@cleberg.net>
Date: Tue, 6 May 2025 21:54:18 -0500
Subject: add and update READMEs (#7)

* add and update READMEs

* Commit from GitHub Actions (Ruff)

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
---
 README.org | 104 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 104 insertions(+)
 create mode 100644 README.org

(limited to 'README.org')

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..c30029b
--- /dev/null
+++ b/README.org
@@ -0,0 +1,104 @@
+* Background
+
+I have been an auditor for years, starting with operational/financial
+audits and quickly transitioning to technology audits early in my
+career.
+
+While performing technology audits, attestations, etc., you will find
+that it requires a lot of manual effort if you don't use the right tools
+to automate as much as possible.
+
+This repository serves as my personal collection of audit tools that I
+want to save and re-use later.
+
+** Scope
+
+While I created the scripts and tools within this repository
+specifically for the applications I use, I am working to include
+edge-cases and niche tools as I can.
+
+For now, refer to the tree below for application coverage.
+
+#+begin_src shell
+tree -I ".git*|venv"
+#+end_src
+
+#+begin_src text
+.
+├── applications
+│   ├── github
+│   │   ├── github_admins.py
+│   │   ├── github_audit_log.py
+│   │   ├── github_branch_protections.py
+│   │   ├── github_commits.py
+│   │   └── README.org
+│   └── gitlab
+│       ├── approvals.py
+│       ├── branch_protections.py
+│       ├── passwords.py
+│       ├── pipelines.py
+│       ├── provisioning.py
+│       ├── README.org
+│       ├── repositories.py
+│       └── users.py
+├── CODEOWNERS
+├── databases
+│   ├── mongo
+│   │   ├── admins.py
+│   │   └── README.org
+│   ├── mysql
+│   │   ├── mysql_admins_alt.sql
+│   │   ├── mysql_admins.sql
+│   │   ├── passwords.sql
+│   │   └── README.org
+│   ├── oracle
+│   │   ├── oracle_admins_alt.sql
+│   │   ├── oracle_admins.sql
+│   │   └── README.org
+│   ├── postgres
+│   │   ├── admins.sql
+│   │   ├── passwords.sql
+│   │   └── README.org
+│   └── sql
+│       ├── admins.sql
+│       ├── passwords
+│       │   ├── example_data.csv
+│       │   ├── passwords.py
+│       │   └── query.sql
+│       └── README.org
+├── LICENSE
+├── os
+│   └── linux
+│       ├── passwords.sh
+│       ├── README.org
+│       └── ssh_root_login.sh
+├── project_management
+│   ├── alteryx
+│   │   └── project_email_reminders.yxmd
+│   ├── dash
+│   │   └── app.py
+│   └── powerbi
+│       └── project_dashboard
+│           ├── project_dashboard.pbix
+│           └── project_data.xlsx
+├── README.org
+├── requirements.txt
+└── sampling
+    ├── README.org
+    ├── sample.html
+    ├── sample-html.png
+    └── sample.py
+#+end_src
+
+* Development
+** Python
+
+For the Python scripts, use the following to activate a virtual
+environment for consistent packing:
+
+#+begin_src shell
+python3 -m venv venv
+source ./venv/bin/activate
+pip install PACKAGE_NAME
+python3 ./PYTHON_SCRIPT.py
+#+end_src
-- 
cgit v1.2.3-70-g09d2