Metadata-Version: 2.1
Name: aws-nuke-exporter
Version: 1.0.0
Summary: A tool for exporting aws-nuke logs in JSON or CSV formats.
Home-page: https://github.com/oijkn/aws-nuke-exporter
Author: oijkn
Author-email: peacefull64@hotmail.fr
License: GPL
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# AWS Nuke Exporter

## Description
AWS Nuke Exporter is a Python tool designed to parse and export the output logs of the [aws-nuke](https://github.com/rebuy-de/aws-nuke) command into more structured and readable formats: JSON or CSV. This tool simplifies the process of analyzing and storing the results generated by AWS Nuke, making it easier for users to review and track the resources managed by AWS Nuke.

## Features
- **Multiple Output Formats**: Supports exporting data into JSON or CSV formats.
- **Detailed Parsing**: Extracts detailed information from the AWS Nuke logs, including resource types, IDs, regions, and additional details.
- **Customizable Export Paths**: Allows users to specify custom paths for the exported data.

## Requirements
- Python 3
- AWS CLI (for AWS Nuke command execution)

## Installation

### From PyPI

You can install `aws-nuke-exporter` directly from PyPI:

```bash
pip install aws-nuke-exporter
```

This command will install the latest version of the `aws-nuke-exporter` package along with all necessary dependencies.

### From Source

Alternatively, you can clone the repository and install it manually:

```bash
git clone https://github.com/oijkn/aws-nuke-exporter.git
cd aws-nuke-exporter
python setup.py install
```

## Usage

After installation, you can use `aws-nuke-exporter` from the command line:

```bash
aws-nuke-exporter <path-to-aws-nuke-output> -f <format> -d <destination-path>
```

### Arguments

- `path-to-aws-nuke-output`: The file path where AWS Nuke output is stored.
- `-f, --format [json|csv]`: The output format. Choose between JSON and CSV. Default is JSON.
- `-d, --destination`: The path where the exported file will be saved. Optional.

### Examples

Export AWS Nuke output to JSON:

```bash
aws-nuke-exporter output.log -f json
```

Export AWS Nuke output to CSV with a custom destination:

```bash
aws-nuke-exporter output.log -f csv -d /path/to/export.csv
```

## Contributing
Contributions to the AWS Nuke Exporter are welcome. Please ensure that your code adheres to the existing style and that all tests pass.

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

## Contact
For any questions or feedback, please open an issue on GitHub.


