Metadata-Version: 2.4
Name: reptor
Version: 0.7
Summary: reptor allows you automating pentest reporting with SysReptor.
Author: Richard Schwabe
Author-email: Aron Molnar <aron@syslifters.com>
Maintainer-email: Syslifters <hello@syslifters.com>
License: Copyright (c) 2023 SysReptor+reptor Developers
        See also the CREDITS.md who contributed to this project.
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project-URL: Homepage, https://github.com/Syslifters/reptor/blob/main/README.md
Project-URL: Documentation, https://github.com/Syslifters/reptor/blob/main/README.md
Project-URL: Bug Tracker, https://github.com/Syslifters/reptor/issues
Project-URL: Source, https://github.com/syslifters/reptor
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: asgiref~=3.6
Requires-Dist: certifi>=2023.5.7
Requires-Dist: charset-normalizer~=3.0
Requires-Dist: cvss~=2.0
Requires-Dist: Django~=4.2
Requires-Dist: idna~=2.0
Requires-Dist: markdown-it-py~=3.0
Requires-Dist: mdurl~=0.1
Requires-Dist: Pygments~=2.7
Requires-Dist: PyYAML>=3.10
Requires-Dist: requests~=2.28.2
Requires-Dist: rich<14,>=10
Requires-Dist: sqlparse~=0.4.3
Requires-Dist: termcolor~=2.3.0
Requires-Dist: urllib3<3,>=1.21.1
Requires-Dist: xmltodict~=0.13
Requires-Dist: tomli<3,>=2.0.1
Requires-Dist: tomli-w~=1.0
Provides-Extra: translate
Requires-Dist: deepl>=1.15.0; extra == "translate"
Provides-Extra: ghostwriter
Requires-Dist: gql[aiohttp]>=3.4.1; extra == "ghostwriter"
Provides-Extra: dev
Requires-Dist: pytest>=7.4.0; extra == "dev"
Provides-Extra: all
Requires-Dist: reptor[dev,ghostwriter,translate]; extra == "all"
Dynamic: license-file

# reptor (alpha version)
reptor allows you to automate pentest reporting with SysReptor.

 * Create findings and notes from tool outputs
 * Upload evidences (also bulk upload)
 * Import data from other reporting tools

**GitHub:** [https://github.com/Syslifters/reptor/](https://github.com/Syslifters/reptor/)  
**Docs:** [https://docs.sysreptor.com/cli/getting-started](https://docs.sysreptor.com/cli/getting-started)   
**Setup:** [https://docs.sysreptor.com/cli/setup](https://docs.sysreptor.com/cli/setup)   
**PyPi:** [https://pypi.org/project/reptor/](https://pypi.org/project/reptor/)   

## Prerequisites

* Python 3.8-3.11
* pip3

## Installation
### From pypi
`pip3 install reptor`

#### Optional dependencies
* translate (requires deepl)
* ghostwriter (requires gql)
* dev (requires pytest)

Install by `pip3 install reptor[translate]`.  
Install all optional dependencies using `pip3 install reptor[all]`

### From source
```
git clone https://github.com/Syslifters/reptor.git
cd reptor
pip3 install .
```

Install [optional dependencies](#optional-dependencies) by `pip3 install .[all]`.

## Configuration
Get your API token from https://<your-installation>/users/self/apitokens/.

```
reptor conf
Server [https://demo.sysre.pt]: 
API Token [Create at https://demo.sysre.pt/users/self/apitokens/]:
Project ID:
Store to config to C:\Users\aron\.sysreptor\config.yaml? [y/n]:
```

### Usage

```usage: reptor [-h] [-s SERVER] [-t TOKEN] [-k] [-p PROJECT_ID]
              [--private-note] [-f] [-v] [--debug] [-n NOTETITLE]
              [--no-timestamp] [--file FILE]

Examples:
                reptor conf
                echo "Upload this!" | reptor note
                reptor file data/*
                cat sslyze.json | reptor sslyze --json --push-findings
                cat nmap.xml | reptor nmap --xml --upload

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         increase output verbosity (> INFO)
  --debug               sets logging to DEBUG
  -n NOTETITLE, --notetitle NOTETITLE
  --no-timestamp        do not prepend timestamp to note
  --file FILE           Local file to read

subcommands:
  
  Core:
   conf                  Shows config and sets config
   plugins               Allows plugin management & development
  
  Projects & Templates:
   projectfindings       Export your project findings as a summary or checklist
   translate             Translate Projects to other languages via Deepl
   template              Queries Finding Templates from SysReptor
   project               Work with projects
  
  Uploads:
   file                  Uploads a file
   finding               Uploads findings from JSON or TOML
   note                  Uploads and lists notes
  
  Tools:
   sslyze                format sslyze JSON output
   nmap                  format nmap output
   zap                   Parses ZAP reports (JSON, XML)
  
  Importers:
   ghostwriter           Imports GhostWriter finding templates
   importers             Show importers to use to import finding templates

configuration:
  -s SERVER, --server SERVER
  -t TOKEN, --token TOKEN
                        SysReptor API token
  -k, --insecure        do not verify server certificate
  -p PROJECT_ID, --project-id PROJECT_ID
                        SysReptor project ID
  --private-note        add notes to private notes
  -f, --force-unlock    force unlock notes

```
