+
+
+
+
+ Hunt down social media accounts by username across 400+ social networks
+
+
+ Additional documentation can be found on our GitHub repository
+
+
+
+## Basic usage
+
+```console
+$ sherlock --help
+usage: sherlock [-h] [--version] [--verbose] [--folderoutput FOLDEROUTPUT]
+ [--output OUTPUT] [--tor] [--unique-tor] [--csv] [--xlsx]
+ [--site SITE_NAME] [--proxy PROXY_URL] [--json JSON_FILE]
+ [--timeout TIMEOUT] [--print-all] [--print-found] [--no-color]
+ [--browse] [--local] [--nsfw]
+ USERNAMES [USERNAMES ...]
+```
+
+To search for only one user:
+```bash
+$ sherlock user123
+```
+
+To search for more than one user:
+```bash
+$ sherlock user1 user2 user3
+```
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pyproject.toml b/pyproject.toml
index 2bfb1cd47..11228285e 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,30 +1,26 @@
[build-system]
-requires = ["setuptools >= 61.0"]
-build-backend = "setuptools.build_meta"
+requires = [ "poetry-core>=1.8.0", "poetry-dynamic-versioning>1.0.0,<2.0.0" ]
+build-backend = "poetry_dynamic_versioning.backend"
-[project.scripts]
-sherlock = "sherlock:main"
+[tool.poetry-dynamic-versioning]
+enable = true
+vcs = "git"
-[project.urls]
-Homepage = "http://sherlock-project.github.io/"
-Repository = "https://github.com/sherlock-project/sherlock.git"
-Issues = "https://github.com/sherlock-project/sherlock/issues"
-
-[project]
-name = "Sherlock"
+[tool.poetry]
+name = "sherlock-project"
+version = "0.0.0"
+description = "Hunt down social media accounts by username across social networks"
+license = "MIT"
authors = [
- { name = "Sherlock Project" }
+ "Siddharth Dushantha"
]
maintainers = [
- { name = "Siddharth Dushantha" },
- { name = "Matheus Felipe" },
- { name = "Sondreal" },
- { name = "Paul Pfeister" }
+ "Paul Pfeister",
+ "Matheus Felipe",
+ "Sondre Karlsen Dyrnes"
]
-description = "Hunt down social media accounts by username across social networks"
-readme = "README.md"
-license = {file = "LICENSE"}
-dynamic = ["dependencies", "version"]
+readme = "docs/pyproj/README.md"
+packages = [ { include = "sherlock" } ]
keywords = [ "osint", "reconnaissance", "information gathering" ]
classifiers = [
"Development Status :: 5 - Production/Stable",
@@ -34,13 +30,27 @@ classifiers = [
"Natural Language :: English",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
- "Topic :: Communications",
"Topic :: Security"
]
-[tool.setuptools.dynamic]
-dependencies = { file = [ "requirements.txt" ] }
-version = { attr = "sherlock.__version__" }
-[tool.setuptools]
-package-dir = {"" = "sherlock"}
+[tool.poetry.urls]
+Homepage = "http://sherlock-project.github.io/"
+Repository = "https://github.com/sherlock-project/sherlock.git"
+Issues = "https://github.com/sherlock-project/sherlock/issues"
+
+[tool.poetry.dependencies]
+python = "^3.8"
+certifi = "^2019.6.16"
+colorama = "^0.4.1"
+PySocks = "^1.7.0"
+requests = "^2.22.0"
+requests-futures = "^1.0.0"
+stem = "^1.8.0"
+torrequest = "^0.1.0"
+pandas = ">1.0.0"
+openpyxl = "^3.0.10"
+exrex = "^0.11.0"
+
+[tool.poetry.scripts]
+sherlock = 'sherlock.sherlock:main'
diff --git a/requirements.txt b/requirements.txt
deleted file mode 100644
index 0bee5bfdf..000000000
--- a/requirements.txt
+++ /dev/null
@@ -1,10 +0,0 @@
-certifi>=2019.6.16
-colorama>=0.4.1
-PySocks>=1.7.0
-requests>=2.22.0
-requests-futures>=1.0.0
-stem>=1.8.0
-torrequest>=0.1.0
-pandas>=1.0.0
-openpyxl<=3.0.10
-exrex>=0.11.0
\ No newline at end of file
diff --git a/sherlock/notify.py b/sherlock/notify.py
index 87bfa0bbd..dc57ea335 100644
--- a/sherlock/notify.py
+++ b/sherlock/notify.py
@@ -3,7 +3,7 @@
This module defines the objects for notifying the caller about the
results of queries.
"""
-from result import QueryStatus
+from sherlock.result import QueryStatus
from colorama import Fore, Style
import webbrowser
diff --git a/sherlock/sherlock.py b/sherlock/sherlock.py
index a8760f2f9..5042b8bf2 100644
--- a/sherlock/sherlock.py
+++ b/sherlock/sherlock.py
@@ -21,10 +21,10 @@
from requests_futures.sessions import FuturesSession
from torrequest import TorRequest
-from result import QueryStatus
-from result import QueryResult
-from notify import QueryNotifyPrint
-from sites import SitesInformation
+from sherlock.result import QueryStatus
+from sherlock.result import QueryResult
+from sherlock.notify import QueryNotifyPrint
+from sherlock.sites import SitesInformation
from colorama import init
from argparse import ArgumentTypeError
diff --git a/sherlock/tests/base.py b/sherlock/tests/base.py
index de958b9db..204c19c0a 100644
--- a/sherlock/tests/base.py
+++ b/sherlock/tests/base.py
@@ -6,9 +6,9 @@
import os.path
import unittest
import sherlock
-from result import QueryStatus
-from notify import QueryNotify
-from sites import SitesInformation
+from sherlock.result import QueryStatus
+from sherlock.notify import QueryNotify
+from sherlock.sites import SitesInformation
import warnings
diff --git a/sherlock/tests/test_multiple_usernames.py b/sherlock/tests/test_multiple_usernames.py
index 418110877..3be803330 100644
--- a/sherlock/tests/test_multiple_usernames.py
+++ b/sherlock/tests/test_multiple_usernames.py
@@ -1,4 +1,3 @@
-import importlib
import unittest
import sys
sys.path.append('../')