Metadata-Version: 2.1
Name: darkfeed
Version: 1.1
Summary: A CLI and GUI parser for data from Dark Feed
Author: Camila Santiago
Keywords: ransomware,victims,darkfeed,dark feed
Description-Content-Type: text/markdown
Requires-Dist: python-dateutil
Requires-Dist: requests
Requires-Dist: openpyxl
Requires-Dist: Flask

# Dark Feed Parser

This is a simples parser for all great data available with the API key of [Dark Feed](https://darkfeed.io/).

The idea is create functions to return data available in the interface and bring more insights, like:
- Top 10 countries this year
- Top 5 sectors in Brazil
- Top 3 ransomwares in latam
- Count of victims in America of the North in the last month
- Filters in a time range
- . . . 

## How install it

```bash
pip install darkfeed
```

## How use the command line 

If you don't know how run it you can use the argument `-h`, like this:

```bash
darkfeed -h
usage: darkfeed [-h] [-i] [-d] [-a AFTER] [-b BEFORE] [-c COUNTRIES] [-lc] [-s SECTORS] [-ls] [-r RANSOMWARES] [-lr] [-v VICTIM] [-top_c TOP_COUNTRIES] [-top_s TOP_SECTORS]
                [-top_r TOP_RANSOMWARES] [-json] [-count] [-xlsx] [-n] [-g]

Ransomware statistics - Kudos DarkFeed (darkfeed.io).

options:
  -h, --help            show this help message and exit
  -i, --init            First step. Pass your API key.
  -d, --download_base   To save/update base to a file
  -a AFTER, --after AFTER
                        Date started to collecting published victims. Format: YYYY-MM-DD
  -b BEFORE, --before BEFORE
                        Date finished to collecting published victims. Format: YYYY-MM-DD
  -c COUNTRIES, --country COUNTRIES
                        Country filer, write how many countries do you want split by [,]. You could also use: latam, south_america, central_america, north_america, europe, asia, africa or
                        oceania
  -lc, --list_countries
                        List all possible strings for countries
  -s SECTORS, --sectors SECTORS
                        Sector filter, choose the sectors of your interest. You can choose more than one split then with [,]
  -ls, --list_sectors   List all possible sectors.
  -r RANSOMWARES, --ransomwares RANSOMWARES
                        Ransomware filter, choose the ransomware group of your interest. You can choose more than one split then with [,]
  -lr, --list_ransomwares
                        List all ransowmare groups in our base
  -v VICTIM, --victim VICTIM
                        Use the name or substring to search a victm.
  -top_c TOP_COUNTRIES, --top_countries TOP_COUNTRIES
                        Get the global top X countries.
  -top_s TOP_SECTORS, --top_sectors TOP_SECTORS
                        Get the global top X sectors.
  -top_r TOP_RANSOMWARES, --top_ransomwares TOP_RANSOMWARES
                        Get the global top X ransomwares.
  -json                 To format your output to json
  -count                To count the num of items
  -xlsx                 To convert data to spreadsheet / xlsx
  -n, --news            Cyber news!
  -g, --start_gui       Init a web service.
```

# How to use the GUI

```bash
darkfeed -g
```

