Metadata-Version: 2.2
Name: kp-analysis-toolkit
Version: 1.0.2
Summary: Python utilities to parse technical information for security audits
Author-email: Randy Bartels <rjbartels@outlook.com>
Project-URL: Homepage, https://github.com/kirkpatrickprice/analysis-toolkit
Project-URL: Issues, https://github.com/kirkpatrickprice/analysis-toolkit/issues
Keywords: pii discovery,data discovery,credit card discovery
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Security
Classifier: Topic :: Utilities
Requires-Python: <4,>=3.9
Description-Content-Type: text/markdown
Requires-Dist: colorama>=0.4.6
Requires-Dist: pandas>=1.5.1
Requires-Dist: pyyaml>=6.0
Requires-Dist: xlsxwriter>=3.0.3
Provides-Extra: dev
Requires-Dist: pytest>=7.4.4; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest>=7.4.4; extra == "test"
Provides-Extra: pypi
Requires-Dist: build>=1.2.1; extra == "pypi"
Requires-Dist: twine>=5.0.0; extra == "pypi"

# analysis-toolkit

The analysis toolkit is a collection of scripts designed to assist auditors analyze the results of the KP system auditing scripts maintained at:
* [Linux](https://github.com/kirkpatrickprice/linux-audit-scripts) 
* [Windows](https://github.com/kirkpatrickprice/windows-audit-scripts)
* [MacOS](https://github.com/kirkpatrickprice/macos-auditor)

## Critical dependencies ##
* Shell: a recent version of `bash`
* Python: A recent release of version 3.  Both 3.10 (Ubuntu 22.04) and 3.12+ should be fine
* Misc. commands:   `grep` `echo` `awk` `sort`

The scripts have been tested and are usually used on Ubuntu distributions. They were developed on WSL instances of Ubuntu 20.04 and 22.04.  YMMV on other distributions or versions, but I don't foresee any problems, say, on a MacOS Terminal prompt.

For KP auditors, I strongly recommend following the [Getting started with WSL](https://kirkpatrickprice.atlassian.net/l/c/jP0AuG7j) and [Bashing Our Way to Efficient Audits](https://kirkpatrickprice.atlassian.net/l/c/6oaQWQpv) pages on Confluence.

I also recommend that you use the Windows Terminal app available from the Microsoft Store.  Among other numerous benefits, this will allow to click on hyperlinks created by some of the tools.

## Installation ##
Prequisites:
* A supported version of Python
* Python's PIPX
    * Windows (and others where PIPX isn't installed by the OS package manager): `pip install pipx`
    * Ubuntu (and for other distro's where it's provided as an OS package): `sudo apt install pipx`

Installation is as simple as using Python's `PIPX` to install the package from PyPI.

### Windows PowerShell ### 
Assuming Python is already installed:
```
pip install pipx
pipx ensurepath
# Restart PowerShell window to get new PATH
pipx install kp-analysis-toolkit
```

### Ubuntu ### 
Or others where PIPX is provided by the OS package manager -- replace `apt` with other package manager as needed:
```
sudo apt install pipx
pipx ensurepath
# Restart shell prompt window to get new PATH
pipx install kp-analysis-toolkit
```

## Updating the toolkit ##
Change to the analysis-toolkit directory

`pipx update kp-analysis-toolkit`

## Using the toolkit scripts ##
Each toolkit script includes a "help" function to explain the options.

`<script> -h`
