Metadata-Version: 2.1
Name: crxcavatorpy
Version: 0.1.3
Summary: Python module for interacting with the Crxcavator api
Author: Garrett Primm
Author-email: garrett@alabamacloudsecurity.com
Requires-Python: >=3.8.1
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: argparse (>=1.4.0,<2.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Description-Content-Type: text/markdown

# Crxcavatorpy

A python package for working with the CRXCavator api as an imported package or as a command line utility

# Installation

```
pip install crxcavatorpy
```

# CLI Usage

## Get a single report
```
# Generic Use
python3 -m crxcavator report <extension_id> <extension_version>

# Example Use
python3 -m crxcavator report aapbdbdomjkkjkaonfhkkikfgjllcleb 2.0.13

```
# Example Output for a single extension report
[report-output.json](docs/report-output.json)


## Get all reports for an extension
```
# Generic Use
python3 -m crxcavator reports <extension_id>

# Example Use
python3 -m crxcavator reports aapbdbdomjkkjkaonfhkkikfgjllcleb

```
### Example Output for all reports for a single extension
[all-reports-output.json](docs/all-reports-output.json)
## Submit an extension to be scanned
```
# Generic Use
python3 -m crxcavator submit <extension_id>

# Example Use
python3 -m crxcavator submit aapbdbdomjkkjkaonfhkkikfgjllcleb

```
### Example Output for extension scan submission
```json
{
  "code": 801,
  "extensionID": "aapbdbdomjkkjkaonfhkkikfgjllcleb",
  "message": "Extension successfully submitted",
  "platform": "Chrome",
  "version": "2.0.13"
}
```
