Commit `b9a6394f09`

b9a6394f09730a373495dbfa84cf4fa0566fd419

parent: 8694aa1620

Unsigned

cmc <hello@cleberg.net> · 2026-02-22 05:56 UTC

update README

Layout: unified · split

README.md deleted −89

	@@ -1,89 +0,0 @@
1	# Audit Tools
2
3	Audit Tools is a collection of open-source Python scripts and related resources intended to support auditors, risk professionals, and data analysts in automating common audit procedures and analyses.
4
5	This repository includes practical examples that can be used as-is or adapted to specific audit environments.
6
7	## Contents
8
9	The repository includes scripts and templates related to:
10
11	- Pseudo-random sampling
12	- General IT controls (GITC) extraction and analysis
13	- Project management tracking and visualization
14	- Cloud platform analysis (planned)
15	- Prompt engineering and AI audit guidance (planned)
16
17	These tools are intended to be straightforward and applicable across a range of audit contexts.
18
19	## Getting Started
20
21	Clone the Repository
22
23	```bash
24	git clone https://github.com/audit-labs/audit-tools
25	cd audit-tools
26	```
27
28	Install Dependencies
29
30	Required for running the Python scripts:
31
32	```bash
33	pip install -r requirements.txt
34
35	# or, if you prefer `uv`:
36	uv run file.py
37	```
38
39	Run a Sample Script
40
41	For example, to run the Linux OS report tool:
42
43	```bash
44	./os/linux/report/linux.sh
45	```
46
47	Output will be shown in the terminal or saved to a file, depending on the script.
48
49	## Resources
50
51	If you're new to scripting or audit analytics, you may find the following helpful:
52
53	- [Python for Auditors](https://realpython.com)
54	- [Audit Analytics 101](https://audit-analytics.com)
55	- [Getting Started with Pandas](https://pandas.pydata.org/docs/getting_started/)
56
57	See the `notebooks/` directory for additional walkthroughs and examples.
58
59	## Contributing
60
61	Contributions are welcome. You can contribute by:
62
63	- Adding new audit-related scripts
64	- Suggesting improvements or feature ideas
65	- Enhancing documentation or tutorials
66	- Testing the tools on additional datasets and reporting any issues
67
68	To contribute:
69
70	1. Fork the repository
71	2. Create a new branch:
72
73	```bash
74	git checkout -b my-feature
75	```
76
77	3. Commit your changes:
78
79	```bash
80	git commit -m 'Added new audit test'
81	```
82
83	4. Push your branch:
84
85	```bash
86	git push origin my-feature
87	```
88
89	5. Open a pull request

README.org added +84

@@ -0,0 +1,84 @@
	1	* Audit Tools
	2
	3	Audit Tools is a collection of open-source Python scripts and related resources
	4	intended to support auditors, risk professionals, and data analysts in
	5	automating common audit procedures and analyses.
	6
	7	This repository includes practical examples that can be used as-is or adapted to
	8	specific audit environments.
	9
	10	** Contents
	11
	12	\| Directory \| Description \|
	13	\|----------------------+------------------------------------------------------------------------------\|
	14	\| =applications/aws/= \| AWS IAM users, password policy, and S3 bucket analysis \|
	15	\| =applications/github/= \| GitHub admin enumeration, audit log, branch protections, and commit analysis \|
	16	\| =applications/gitlab/= \| GitLab user provisioning, branch protections, approvals, pipelines, and more \|
	17	\| =databases/mongo/= \| MongoDB admin enumeration \|
	18	\| =databases/mysql/= \| MySQL admin and password queries \|
	19	\| =databases/oracle/= \| Oracle admin queries \|
	20	\| =databases/postgres/= \| PostgreSQL admin and password queries \|
	21	\| =databases/sql/= \| Generic SQL admin queries and password analysis \|
	22	\| =os/linux/= \| Linux OS reporting, password file analysis, and SSH root login checks \|
	23	\| =project_management/= \| Audit project tracking dashboards (Alteryx, Dash, Power BI) \|
	24	\| =sampling/= \| Random and stratified sampling tools \|
	25
	26	** Getting Started
	27
	28	Clone the Repository
	29
	30	#+begin_src bash
	31	git clone https://github.com/audit-lab/audit-toolss
	32	cd audit-tools
	33	#+end_src
	34
	35	#+RESULTS:
	36
	37	Install Dependencies
	38
	39	#+begin_src bash
	40	pip install -r requirements.txt
	41	#+end_src
	42
	43	Run a Script
	44
	45	For example, to run the Linux OS report tool:
	46
	47	#+begin_src bash
	48	./os/linux/report/linux.sh
	49	#+end_src
	50
	51	Or to run a Python script:
	52
	53	#+begin_src bash
	54	python sampling/sample.py
	55	#+end_src
	56
	57	Output will be shown in the terminal or saved to a file, depending on the
	58	script.
	59
	60	** Contributing
	61
	62	Contributions are welcome. You can contribute by:
	63
	64	- Adding new audit-related scripts
	65	- Suggesting improvements or feature ideas
	66	- Enhancing documentation
	67	- Testing the tools on additional datasets and reporting any issues
	68
	69	To contribute:
	70
	71	1. Fork the repository
	72	2. Create a new branch:
	73	#+begin_src bash
	74	git checkout -b my-feature
	75	#+end_src
	76	3. Commit your changes:
	77	#+begin_src bash
	78	git commit -m 'Added new audit test'
	79	#+end_src
	80	4. Push your branch:
	81	#+begin_src bash
	82	git push origin my-feature
	83	#+end_src
	84	5. Open a pull request

Commit b9a6394f09

Commit `b9a6394f09`