Metadata-Version: 2.1
Name: w01fm00n
Version: 0.3.0
Summary: terminal-based forensic utility
Home-page: https://github.com/w01fdev/w01fm00n
Author: w01f
Author-email: w01f@w01f.dev
License: GPL-3.0
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.3
Description-Content-Type: text/markdown

# w01fm00n
### terminal-based forensic utility

the main test is the use via a terminal, but m00n should also be usable 
as a module without any problems.

## installation
`pip install w01fm00n`

## syntax
```text
usage: w01fm00n [-h] [-a] [-r] [-v] root file

positional arguments:
  root           root directory of the scan
  file           file into which the scan is to be written

optional arguments:
  -h, --help     show this help message and exit
  -a, --archive  archive the <.csv> file as <.tar.gz> and then delete it.
  -r, --raw      output in raw format -> partly difficult to read for humans -> default: <False>
  -v, --version  show program's version number and exit
```

## examples of usage
### pip installation
#### save in the program directory:
`w01fm00n '/home/user/Pictures/' 'data.csv'`

#### save with an absolute path in raw mode as archive:
`w01fm00n.py -r -a '/home/user/Pictures/' '/home/user/m00n/data.csv'`

### github package
#### save in the program directory:
`python w01fm00n.py '/home/user/Pictures/' 'data.csv'`

#### save with an absolute path in raw mode as archive:
`python w01fm00n.py -r -a '/home/user/Pictures/' '/home/user/m00n/data.csv'`

#### further information:
see docstrings in w01fm00n.py

## planned future implementations and improvements:
https://github.com/w01fdev/w01fm00n/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement


