Commit f20f427a55
Unsigned
Layout: unified · split
README.org → README.md renamed +23 −24
| @@ -1,30 +1,29 @@ | |||
| 1 | #+title: README | 1 | # Background |
| 2 | 2 | ||
| 3 | * Background | 3 | I have been an auditor for years, starting with operational/financial |
| 4 | audits and quickly transitioning to technology audits early in my | ||
| 5 | career. | ||
| 4 | 6 | ||
| 5 | I have been an auditor for years, starting with operational/financial audits and | 7 | While performing technology audits, attestations, etc., you will find |
| 6 | quickly transitioning to technology audits early in my career. | 8 | that it requires a lot of manual effort if you don\'t use the right |
| 9 | tools to automate as much as possible. | ||
| 7 | 10 | ||
| 8 | While performing technology audits, attestations, etc., you will find that it | 11 | This repository serves as my personal collection of audit tools that I |
| 9 | requires a lot of manual effort if you don't use the right tools to automate as | 12 | want to save and re-use later. |
| 10 | much as possible. | ||
| 11 | 13 | ||
| 12 | This repository serves as my personal collection of audit tools that I want to | 14 | ## Scope |
| 13 | save and re-use later. | ||
| 14 | 15 | ||
| 15 | ** Scope | 16 | While I created the scripts and tools within this repository |
| 16 | 17 | specifically for the applications I use, I am working to include | |
| 17 | While I created the scripts and tools within this repository specifically for | 18 | edge-cases and niche tools as I can. |
| 18 | the applications I use, I am working to include edge-cases and niche tools as I | ||
| 19 | can. | ||
| 20 | 19 | ||
| 21 | For now, refer to the tree below for application coverage. | 20 | For now, refer to the tree below for application coverage. |
| 22 | 21 | ||
| 23 | #+begin_src shell | 22 | ```shell |
| 24 | tree -I ".git*|venv" | 23 | tree -I ".git*|venv" |
| 25 | #+end_src | 24 | ``` |
| 26 | 25 | ||
| 27 | #+begin_src text | 26 | ```text |
| 28 | . | 27 | . |
| 29 | ├── applications | 28 | ├── applications |
| 30 | │ ├── github | 29 | │ ├── github |
| @@ -76,18 +75,18 @@ tree -I ".git*|venv" | |||
| 76 | ├── sample-html.png | 75 | ├── sample-html.png |
| 77 | ├── sample.html | 76 | ├── sample.html |
| 78 | └── sample.py | 77 | └── sample.py |
| 79 | #+end_src | 78 | ``` |
| 80 | 79 | ||
| 81 | * Development | 80 | # Development |
| 82 | 81 | ||
| 83 | ** Python | 82 | ## Python |
| 84 | 83 | ||
| 85 | For the Python scripts, use the following to activate a virtual environment for | 84 | For the Python scripts, use the following to activate a virtual |
| 86 | consistent packing: | 85 | environment for consistent packing: |
| 87 | 86 | ||
| 88 | #+begin_src sh | 87 | ```shell |
| 89 | python3 -m venv venv | 88 | python3 -m venv venv |
| 90 | source ./venv/bin/activate | 89 | source ./venv/bin/activate |
| 91 | pip install PACKAGE_NAME | 90 | pip install PACKAGE_NAME |
| 92 | python3 ./PYTHON_SCRIPT.py | 91 | python3 ./PYTHON_SCRIPT.py |
| 93 | #+end_src | 92 | ``` |