Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master' into async-requests
Browse files Browse the repository at this point in the history
# Conflicts:
#	.gitignore
#	requirements.txt
#	sherlock.py
  • Loading branch information
nareddyt committed Dec 30, 2018
2 parents c4c3153 + 9b83571 commit 78a3451
Show file tree
Hide file tree
Showing 6 changed files with 443 additions and 109 deletions.
14 changes: 11 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# User files
# Virtual Environment
venv/

# Jupyter Notebook
.ipynb_checkpoints
*.ipynb

# Output files, except requirements.txt
*.txt
!requirements.txt

# Virtual Environment
venv/
# Comma-Separated Values (CSV) Reports
*.csv
30 changes: 26 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Sherlock
> Find usernames across over 75 social networks
> Find usernames across social networks
<p align="center">
<img src="sherlock_preview.png">
<img src="preview.png">
</a>
</p>

## Installation

**NOTE**: Python 3.6 or higher is required.

```bash
# clone the repo
$ git clone https://github.com/sdushantha/sherlock.git
Expand All @@ -20,10 +22,30 @@ $ pip3 install -r requirements.txt
```

## Usage
Just run ```python3 sherlock.py```

All of the accounts found will be stored in a text file with their usename (e.g ```user123.txt```)
```bash
$ python3 sherlock.py --help
usage: sherlock.py [-h] [--version] [--verbose] [--quiet] [--csv] [--tor] [--unique-tor]
USERNAMES [USERNAMES ...]

Sherlock: Find Usernames Across Social Networks (Version 0.1.0)

positional arguments:
USERNAMES One or more usernames to check with social networks.

optional arguments:
-h, --help show this help message and exit
--version Display version information and dependencies.
--verbose, -v, -d, --debug
Display extra debugging information.
--quiet, -q Disable debugging information (Default Option).
--csv Create Comma-Separated Values (CSV) File.
--tor, -t Make requests over TOR; increases runtime; requires TOR to be installed and in system path.
--unique-tor, -u Make requests over TOR with new TOR circuit after each request; increases runtime; requires TOR to be installed and in system path.
```

For example, run ```python3 sherlock.py user123```, and all of the accounts
found will be stored in a text file with the username (e.g ```user123.txt```).

## License
MIT License
Expand Down
Loading

0 comments on commit 78a3451

Please sign in to comment.