audit-labs/audit-tools

A collection of scripts, queries, and other goodies you can use in an audit.

clone: git clone https://gitbay.org/audit-labs/audit-tools.git

6f6c450e140045bca15c2fada70ae436b58c41be

signed_unknown_key

author: Christian Cleberg <hello@cleberg.net> ยท 2025-05-28T17:59:42Z
committer: <noreply@github.com>

feat: convert README to org-mode and update content (#10)

 README.org | 178 ++++++++++++++++++++++++++++++-------------------------------
 1 file changed, 88 insertions(+), 90 deletions(-)

diff --git a/README.org b/README.org
index c30029b..8312cf6 100644
--- a/README.org
+++ b/README.org
@@ -1,104 +1,102 @@
-* Background
+#+TITLE: Audit Tools by Christian Cleberg
+#+AUTHOR: Christian Cleberg
+#+OPTIONS: toc:nil
 
-I have been an auditor for years, starting with operational/financial
-audits and quickly transitioning to technology audits early in my
-career.
+* ๐Ÿ“Š Audit Tools by Christian Cleberg
 
-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.
+Welcome to *Audit Tools* โ€” a collection of open-source Python scripts and
+resources designed to help auditors, risk professionals, and data analysts
+automate common audit tasks and analytics.
 
-This repository serves as my personal collection of audit tools that I
-want to save and re-use later.
+Whether you're new to audit automation or an experienced tech-enabled auditor,
+this toolkit offers practical, real-world examples you can use, customize, and
+build upon.
 
-** Scope
+* ๐Ÿ“ฆ What's Inside
 
-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.
+This repository contains Python scripts and templates for common audit
+procedures and control testing activities, including:
 
-For now, refer to the tree below for application coverage.
+- โœ… *Pseudo-Random Sampling*
+- โœ… *GITC Extractions and Analysis*
+- โœ… *Project Management Tracking & Visualizations*
+- โœ… *Cloud Platform Analysis (planned)*
+- โœ… *Audit AI Prompts & Guides (planned)*
 
-#+begin_src shell
-tree -I ".git*|venv"
+The goal is to provide practical, easy-to-understand tools that auditors and
+analysts can quickly deploy in their environments.
+
+* ๐Ÿš€ Getting Started
+
+**Clone the Repository**
+
+#+begin_src bash
+git clone https://github.com/ccleberg/audit-tools.git
+cd audit-tools
 #+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
+**Install Dependencies**
+
+/Required for Python scripts/
+
+#+begin_src bash
+pip install -r requirements.txt
 #+end_src
 
-* Development
-** Python
+**Run a Sample Script**
 
-For the Python scripts, use the following to activate a virtual
-environment for consistent packing:
+Example: Run the *Linux OS Report* tool.
 
-#+begin_src shell
-python3 -m venv venv
-source ./venv/bin/activate
-pip install PACKAGE_NAME
-python3 ./PYTHON_SCRIPT.py
+#+begin_src bash
+./os/linux/report/linux.sh
 #+end_src
+
+View the results in your terminal or within the file created by the script.
+
+* ๐Ÿ“– Learn More
+
+If you're new to audit analytics or Python scripting, start here:
+- [[https://realpython.com][Python for Auditors]]
+- [[https://audit-analytics.com][Audit Analytics 101]]
+- [[https://pandas.pydata.org/docs/getting_started/][Intro to Pandas Documentation]]
+
+Also, check out the =notebooks/= folder for interactive tutorials and use cases.
+
+* ๐Ÿค How to Contribute
+
+Want to add your own audit scripts or improve existing ones? Contributions are
+welcome!
+
+**Ways to Help**
+- Submit new Python scripts for audit use cases.
+- Suggest enhancements or new features via [[https://github.com/ccleberg/audit-tools/issues][Issues]].
+- Improve documentation or write beginner-friendly tutorials.
+- Test existing tools on new datasets and report issues.
+
+**To Contribute**
+1. Fork this repo
+2. Create a new branch:
+   #+begin_src bash
+   git checkout -b my-feature
+   #+end_src
+3. Commit your changes:
+   #+begin_src bash
+   git commit -m 'Added new audit test'
+   #+end_src
+4. Push to the branch:
+   #+begin_src bash
+   git push origin my-feature
+   #+end_src
+5. Open a Pull Request
+
+* ๐Ÿ‘ค About the Creator
+
+Made with โค๏ธ by [[https://cleberg.net/][Christian Cleberg]].
+
+I'm a technology assurance leader passionate about audit innovation, AI in
+audit, and building practical tools for auditors and risk professionals.
+
+* ๐Ÿ“œ License
+
+This project is licensed under the *GNU General Public License v3.0* โ€” see the
+[[file:LICENSE][LICENSE]] file for details.