aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: f2be0d7140a13c630193afa60cdd19833df1e1f2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# 📊 Audit Tools by Christian Cleberg

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.

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.

# 📦 What's Inside

This repository contains Python scripts and templates for common audit
procedures and control testing activities, including:

- **Pseudo-Random Sampling**
- **GITC Extractions and Analysis**
- **Project Management Tracking & Visualizations**
- **Cloud Platform Analysis (planned)**
- **Audit AI Prompts & Guides (planned)**

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****

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

****Install Dependencies****

*Required for Python scripts*

``` bash
pip install -r requirements.txt
```

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

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

``` bash
./os/linux/report/linux.sh
```

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:

- [Python for Auditors](https://realpython.com)
- [Audit Analytics 101](https://audit-analytics.com)
- [Intro to Pandas
  Documentation](https://pandas.pydata.org/docs/getting_started/)

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.
- 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:

    ``` bash
    git checkout -b my-feature
    ```

3.  Commit your changes:

    ``` bash
    git commit -m 'Added new audit test'
    ```

4.  Push to the branch:

    ``` bash
    git push origin my-feature
    ```

5.  Open a Pull Request

# 👤 About the Creator

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

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 [LICENSE](LICENSE) file for details.