Commit `31922eb3f1`

31922eb3f1ba91b956b0dde94d35e061f7c7c573

parent: 7eb1b86bc9

Unsigned

cmc <hello@cleberg.net> · 2025-05-28 17:59 UTC
committer: <noreply@github.com>

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

Layout: unified · split

README.org +88 −90

	@@ -1,104 +1,102 @@
1	* Background	1	#+TITLE: Audit Tools by Christian Cleberg
		2	#+AUTHOR: Christian Cleberg
		3	#+OPTIONS: toc:nil
2		4
3	I have been an auditor for years, starting with operational/financial	5	* 📊 Audit Tools by Christian Cleberg
4	audits and quickly transitioning to technology audits early in my
5	career.
6		6
7	While performing technology audits, attestations, etc., you will find	7	Welcome to Audit Tools — a collection of open-source Python scripts and
8	that it requires a lot of manual effort if you don't use the right tools	8	resources designed to help auditors, risk professionals, and data analysts
9	to automate as much as possible.	9	automate common audit tasks and analytics.
10		10
11	This repository serves as my personal collection of audit tools that I	11	Whether you're new to audit automation or an experienced tech-enabled auditor,
12	want to save and re-use later.	12	this toolkit offers practical, real-world examples you can use, customize, and
		13	build upon.
13		14
14	** Scope	15	* 📦 What's Inside
15		16
16	While I created the scripts and tools within this repository	17	This repository contains Python scripts and templates for common audit
17	specifically for the applications I use, I am working to include	18	procedures and control testing activities, including:
18	edge-cases and niche tools as I can.
19		19
20	For now, refer to the tree below for application coverage.	20	- ✅ Pseudo-Random Sampling
		21	- ✅ GITC Extractions and Analysis
		22	- ✅ Project Management Tracking & Visualizations
		23	- ✅ Cloud Platform Analysis (planned)
		24	- ✅ Audit AI Prompts & Guides (planned)
21		25
22	#+begin_src shell	26	The goal is to provide practical, easy-to-understand tools that auditors and
23	tree -I ".git*\|venv"	27	analysts can quickly deploy in their environments.
		28
		29	* 🚀 Getting Started
		30
		31	Clone the Repository
		32
		33	#+begin_src bash
		34	git clone https://github.com/ccleberg/audit-tools.git
		35	cd audit-tools
24	#+end_src	36	#+end_src
25		37
26	#+begin_src text	38	Install Dependencies
27	.	39
28	├── applications	40	/Required for Python scripts/
29	│ ├── github	41
30	│ │ ├── github_admins.py	42	#+begin_src bash
31	│ │ ├── github_audit_log.py	43	pip install -r requirements.txt
32	│ │ ├── github_branch_protections.py
33	│ │ ├── github_commits.py
34	│ │ └── README.org
35	│ └── gitlab
36	│ ├── approvals.py
37	│ ├── branch_protections.py
38	│ ├── passwords.py
39	│ ├── pipelines.py
40	│ ├── provisioning.py
41	│ ├── README.org
42	│ ├── repositories.py
43	│ └── users.py
44	├── CODEOWNERS
45	├── databases
46	│ ├── mongo
47	│ │ ├── admins.py
48	│ │ └── README.org
49	│ ├── mysql
50	│ │ ├── mysql_admins_alt.sql
51	│ │ ├── mysql_admins.sql
52	│ │ ├── passwords.sql
53	│ │ └── README.org
54	│ ├── oracle
55	│ │ ├── oracle_admins_alt.sql
56	│ │ ├── oracle_admins.sql
57	│ │ └── README.org
58	│ ├── postgres
59	│ │ ├── admins.sql
60	│ │ ├── passwords.sql
61	│ │ └── README.org
62	│ └── sql
63	│ ├── admins.sql
64	│ ├── passwords
65	│ │ ├── example_data.csv
66	│ │ ├── passwords.py
67	│ │ └── query.sql
68	│ └── README.org
69	├── LICENSE
70	├── os
71	│ └── linux
72	│ ├── passwords.sh
73	│ ├── README.org
74	│ └── ssh_root_login.sh
75	├── project_management
76	│ ├── alteryx
77	│ │ └── project_email_reminders.yxmd
78	│ ├── dash
79	│ │ └── app.py
80	│ └── powerbi
81	│ └── project_dashboard
82	│ ├── project_dashboard.pbix
83	│ └── project_data.xlsx
84	├── README.org
85	├── requirements.txt
86	└── sampling
87	├── README.org
88	├── sample.html
89	├── sample-html.png
90	└── sample.py
91	#+end_src	44	#+end_src
92		45
93	* Development	46	Run a Sample Script
94	** Python
95		47
96	For the Python scripts, use the following to activate a virtual	48	Example: Run the Linux OS Report tool.
97	environment for consistent packing:
98		49
99	#+begin_src shell	50	#+begin_src bash
100	python3 -m venv venv	51	./os/linux/report/linux.sh
101	source ./venv/bin/activate
102	pip install PACKAGE_NAME
103	python3 ./PYTHON_SCRIPT.py
104	#+end_src	52	#+end_src
		53
		54	View the results in your terminal or within the file created by the script.
		55
		56	* 📖 Learn More
		57
		58	If you're new to audit analytics or Python scripting, start here:
		59	- [[https://realpython.com][Python for Auditors]]
		60	- [[https://audit-analytics.com][Audit Analytics 101]]
		61	- [[https://pandas.pydata.org/docs/getting_started/][Intro to Pandas Documentation]]
		62
		63	Also, check out the =notebooks/= folder for interactive tutorials and use cases.
		64
		65	* 🤝 How to Contribute
		66
		67	Want to add your own audit scripts or improve existing ones? Contributions are
		68	welcome!
		69
		70	Ways to Help
		71	- Submit new Python scripts for audit use cases.
		72	- Suggest enhancements or new features via [[https://github.com/ccleberg/audit-tools/issues][Issues]].
		73	- Improve documentation or write beginner-friendly tutorials.
		74	- Test existing tools on new datasets and report issues.
		75
		76	To Contribute
		77	1. Fork this repo
		78	2. Create a new branch:
		79	#+begin_src bash
		80	git checkout -b my-feature
		81	#+end_src
		82	3. Commit your changes:
		83	#+begin_src bash
		84	git commit -m 'Added new audit test'
		85	#+end_src
		86	4. Push to the branch:
		87	#+begin_src bash
		88	git push origin my-feature
		89	#+end_src
		90	5. Open a Pull Request
		91
		92	* 👤 About the Creator
		93
		94	Made with ❤️ by [[https://cleberg.net/][Christian Cleberg]].
		95
		96	I'm a technology assurance leader passionate about audit innovation, AI in
		97	audit, and building practical tools for auditors and risk professionals.
		98
		99	* 📜 License
		100
		101	This project is licensed under the GNU General Public License v3.0 — see the
		102	[[file:LICENSE][LICENSE]] file for details.

Commit 31922eb3f1

Commit `31922eb3f1`