d46eb2da13 · audit-labs/audit-tools

1

# 📊 Audit Tools by Christian Cleberg

1

# Audit Tools by Christian Cleberg

2

3

Welcome to **Audit Tools** — a collection of open-source Python scripts

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

and resources designed to help auditors, risk professionals, and data

5

analysts automate common audit tasks and analytics.

6

4

7

Whether you're new to audit automation or an experienced tech-enabled

5

This repository includes practical examples that can be used as-is or adapted to specific audit environments.

8

auditor, this toolkit offers practical, real-world examples you can use,

9

customize, and build upon.

10

6

11

# 📦 What's Inside

7

## Contents

12

8

13

This repository contains Python scripts and templates for common audit

9

The repository includes scripts and templates related to:

14

procedures and control testing activities, including:

15

10

16

- ✅ **Pseudo-Random Sampling**

11

- Pseudo-random sampling

17

- ✅ **GITC Extractions and Analysis**

12

- General IT controls (GITC) extraction and analysis

18

- ✅ **Project Management Tracking & Visualizations**

13

- Project management tracking and visualization

19

- ✅ **Cloud Platform Analysis (planned)**

14

- Cloud platform analysis (planned)

20

- ✅ **Audit AI Prompts & Guides (planned)**

15

- Prompt engineering and AI audit guidance (planned)

21

16

22

The goal is to provide practical, easy-to-understand tools that auditors

17

These tools are intended to be straightforward and applicable across a range of audit contexts.

23

and analysts can quickly deploy in their environments.

24

18

25

# 🚀 Getting Started

19

## Getting Started

26

20

27

****Clone the Repository****

21

**Clone the Repository**

28

22

29

``` bash

23

```bash

30

git clone https://git.sr.ht/~cxc/audit-tools

24

git clone https://git.sr.ht/~cxc/audit-tools

31

cd audit-tools

25

cd audit-tools

32

```

26

```

33

27

34

****Install Dependencies****

28

**Install Dependencies**

35

29

36

*Required for Python scripts*

30

Required for running the Python scripts:

37

31

38

``` bash

32

```bash

39

pip install -r requirements.txt

33

pip install -r requirements.txt

40

```

34

```

41

35

42

****Run a Sample Script****

36

**Run a Sample Script**

43

37

44

Example: Run the **Linux OS Report** tool.

38

For example, to run the Linux OS report tool:

45

39

46

``` bash

40

```bash

47

./os/linux/report/linux.sh

41

./os/linux/report/linux.sh

48

```

42

```

49

43

50

View the results in your terminal or within the file created by the

44

Output will be shown in the terminal or saved to a file, depending on the script.

51

script.

52

45

53

# 📖 Learn More

46

## Resources

54

47

55

If you're new to audit analytics or Python scripting, start here:

48

If you're new to scripting or audit analytics, you may find the following helpful:

56

49

57

- [Python for Auditors](https://realpython.com)

50

- [Python for Auditors](https://realpython.com)

58

- [Audit Analytics 101](https://audit-analytics.com)

51

- [Audit Analytics 101](https://audit-analytics.com)

59

- [Intro to Pandas

52

- [Getting Started with Pandas](https://pandas.pydata.org/docs/getting_started/)

60

Documentation](https://pandas.pydata.org/docs/getting_started/)

61

53

62

Also, check out the `notebooks/` folder for interactive tutorials and

54

See the `notebooks/` directory for additional walkthroughs and examples.

63

use cases.

64

55

65

# 🤝 How to Contribute

56

## Contributing

66

57

67

Want to add your own audit scripts or improve existing ones?

58

Contributions are welcome. You can contribute by:

68

Contributions are welcome!

69

59

70

****Ways to Help****

60

- Adding new audit-related scripts

61

- Suggesting improvements or feature ideas

62

- Enhancing documentation or tutorials

63

- Testing the tools on additional datasets and reporting any issues

71

64

72

- Submit new Python scripts for audit use cases.

65

To contribute:

73

- Suggest enhancements or new features.

74

- Improve documentation or write beginner-friendly tutorials.

75

- Test existing tools on new datasets and report issues.

76

66

77

****To Contribute****

67

1. Fork the repository

68

2. Create a new branch:

78

69

79

1. Fork this repo

70

```bash

71

git checkout -b my-feature

72

```

80

73

81

2. Create a new branch:

74

3. Commit your changes:

82

75

83

    ``` bash

76

   ```bash

84

git checkout -b my-feature

77

git commit -m 'Added new audit test'

85

```

78

```

86

79

87

3. Commit your changes:

80

4. Push your branch:

88

81

89

    ``` bash

82

   ```bash

90

git commit -m 'Added new audit test'

83

git push origin my-feature

91

```

84

```

92

85

93

4. Push to the branch:

86

5. Open a pull request

94

87

95

    ``` bash

88

## About

96

git push origin my-feature

97

```

98

89

99

5. Open a Pull Request

90

Created by [Christian Cleberg](https://cleberg.net/), with an interest in practical audit tooling, automation, and applied data analysis in risk and assurance.

100

91

101

# 👤 About the Creator

92

## License

102

93

103

Made with ❤️ by [Christian Cleberg](https://cleberg.net/).

94

This project is licensed under the [GNU General Public License v3.0](LICENSE).

104

105

I'm a technology assurance leader passionate about audit innovation, AI

106

in audit, and building practical tools for auditors and risk

107

professionals.

108

109

# 📜 License

110

111

This project is licensed under the **GNU General Public License v3.0** —

112

see the [LICENSE](LICENSE) file for details.

	@@ -1,112 +1,94 @@
1	# 📊 Audit Tools by Christian Cleberg	1	# Audit Tools by Christian Cleberg
2		2
3	Welcome to Audit Tools — a collection of open-source Python scripts	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	and resources designed to help auditors, risk professionals, and data
5	analysts automate common audit tasks and analytics.
6		4
7	Whether you're new to audit automation or an experienced tech-enabled	5	This repository includes practical examples that can be used as-is or adapted to specific audit environments.
8	auditor, this toolkit offers practical, real-world examples you can use,
9	customize, and build upon.
10		6
11	# 📦 What's Inside	7	## Contents
12		8
13	This repository contains Python scripts and templates for common audit	9	The repository includes scripts and templates related to:
14	procedures and control testing activities, including:
15		10
16	- ✅ Pseudo-Random Sampling	11	- Pseudo-random sampling
17	- ✅ GITC Extractions and Analysis	12	- General IT controls (GITC) extraction and analysis
18	- ✅ Project Management Tracking & Visualizations	13	- Project management tracking and visualization
19	- ✅ Cloud Platform Analysis (planned)	14	- Cloud platform analysis (planned)
20	- ✅ Audit AI Prompts & Guides (planned)	15	- Prompt engineering and AI audit guidance (planned)
21		16
22	The goal is to provide practical, easy-to-understand tools that auditors	17	These tools are intended to be straightforward and applicable across a range of audit contexts.
23	and analysts can quickly deploy in their environments.
24		18
25	# 🚀 Getting Started	19	## Getting Started
26		20
27	**Clone the Repository**	21	Clone the Repository
28		22
29	``` bash	23	```bash
30	git clone https://git.sr.ht/~cxc/audit-tools	24	git clone https://git.sr.ht/~cxc/audit-tools
31	cd audit-tools	25	cd audit-tools
32	```	26	```
33		27
34	**Install Dependencies**	28	Install Dependencies
35		29
36	Required for Python scripts	30	Required for running the Python scripts:
37		31
38	``` bash	32	```bash
39	pip install -r requirements.txt	33	pip install -r requirements.txt
40	```	34	```
41		35
42	**Run a Sample Script**	36	Run a Sample Script
43		37
44	Example: Run the Linux OS Report tool.	38	For example, to run the Linux OS report tool:
45		39
46	``` bash	40	```bash
47	./os/linux/report/linux.sh	41	./os/linux/report/linux.sh
48	```	42	```
49		43
50	View the results in your terminal or within the file created by the	44	Output will be shown in the terminal or saved to a file, depending on the script.
51	script.
52		45
53	# 📖 Learn More	46	## Resources
54		47
55	If you're new to audit analytics or Python scripting, start here:	48	If you're new to scripting or audit analytics, you may find the following helpful:
56		49
57	- [Python for Auditors](https://realpython.com)	50	- [Python for Auditors](https://realpython.com)
58	- [Audit Analytics 101](https://audit-analytics.com)	51	- [Audit Analytics 101](https://audit-analytics.com)
59	- [Intro to Pandas	52	- [Getting Started with Pandas](https://pandas.pydata.org/docs/getting_started/)
60	Documentation](https://pandas.pydata.org/docs/getting_started/)
61		53
62	Also, check out the `notebooks/` folder for interactive tutorials and	54	See the `notebooks/` directory for additional walkthroughs and examples.
63	use cases.
64		55
65	# 🤝 How to Contribute	56	## Contributing
66		57
67	Want to add your own audit scripts or improve existing ones?	58	Contributions are welcome. You can contribute by:
68	Contributions are welcome!
69		59
70	**Ways to Help**	60	- Adding new audit-related scripts
		61	- Suggesting improvements or feature ideas
		62	- Enhancing documentation or tutorials
		63	- Testing the tools on additional datasets and reporting any issues
71		64
72	- Submit new Python scripts for audit use cases.	65	To contribute:
73	- Suggest enhancements or new features.
74	- Improve documentation or write beginner-friendly tutorials.
75	- Test existing tools on new datasets and report issues.
76		66
77	**To Contribute**	67	1. Fork the repository
		68	2. Create a new branch:
78		69
79	1. Fork this repo	70	```bash
		71	git checkout -b my-feature
		72	```
80		73
81	2. Create a new branch:	74	3. Commit your changes:
82		75
83	``` bash	76	```bash
84	git checkout -b my-feature	77	git commit -m 'Added new audit test'
85	```	78	```
86		79
87	3. Commit your changes:	80	4. Push your branch:
88		81
89	``` bash	82	```bash
90	git commit -m 'Added new audit test'	83	git push origin my-feature
91	```	84	```
92		85
93	4. Push to the branch:	86	5. Open a pull request
94		87
95	``` bash	88	## About
96	git push origin my-feature
97	```
98		89
99	5. Open a Pull Request	90	Created by [Christian Cleberg](https://cleberg.net/), with an interest in practical audit tooling, automation, and applied data analysis in risk and assurance.
100		91
101	# 👤 About the Creator	92	## License
102		93
103	Made with ❤️ by [Christian Cleberg](https://cleberg.net/).	94	This project is licensed under the [GNU General Public License v3.0](LICENSE).
104
105	I'm a technology assurance leader passionate about audit innovation, AI
106	in audit, and building practical tools for auditors and risk
107	professionals.
108
109	# 📜 License
110
111	This project is licensed under the GNU General Public License v3.0 —
112	see the [LICENSE](LICENSE) file for details.

Commit d46eb2da13

Commit `d46eb2da13`