Switch PyProject to Poetry

.github/CODEOWNERS

@@ -6,6 +6,3 @@
 # Changes made to these items without code owner approval may negatively
 # impact packaging pipelines. Code owners may need time to verify or adapt.
 /pyproject.toml @ppfeister @sdushantha
-/setup.cfg @ppfeister @sdushantha
-/setup.py @ppfeister
-/*.spec @ppfeister

docs/CONTRIBUTING.md

@@ -68,7 +68,7 @@ Sherlock.  This invocation hides the progress text that Sherlock normally
 outputs, and instead shows the verbose output of the tests.
 
 ```console
-$ cd sherlock/sherlock
+# Assumes pwd is respository root
 $ python3 -m unittest tests.all --verbose
 ```
 

docs/README.md

@@ -27,11 +27,11 @@
 [![PyPI - Version](https://img.shields.io/pypi/v/sherlock-project?logo=PyPi&label=PyPI&color=darkgreen)][ext_pypi] [![Docker Image Version](https://img.shields.io/docker/v/sherlock/sherlock?sort=semver&logo=docker&label=Docker&color=darkgreen)][docs_docker] [![homebrew version](https://img.shields.io/homebrew/v/sherlock?logo=Homebrew&color=darkgreen)][ext_brew]
 
 
-| Method | Command | Notes |
+| | Command | Notes |
 | - | - | - |
-| pypi | `pipx install sherlock-project` | `pip` may be used in place of `pipx` |
-| brew | `brew install sherlock` | Community supported |
-| docker | `docker pull sherlock/sherlock` | |
+| PyPI | `pipx install sherlock-project` | `pip` may be used in place of `pipx` |
+| Homebrew | `brew install sherlock` | Community supported |
+| Docker | `docker pull sherlock/sherlock` | |
 
 ### Alternative guides and methods
 
@@ -133,15 +133,10 @@ Original Creator - [Siddharth Dushantha](https://github.com/sdushantha)
 
 [docs_install]: /docs/install.md
 [docs_docker]: /docs/install.md#docker
-[docs_docker_dockerhub]: /docs/install.md#docker
-[docs_docker_compose]: /docs/install.md#using-compose
-[docs_docker_source]: /docs/install.md#build-image-from-source-useful-for-contributors
 [docs_py]: /docs/install.md#python
-[docs_py_build]: /docs/install.md#build-python-package-from-source-useful-for-contributors
 [docs_contrib]: /docs/CONTRIBUTING.md
 [docs_contrib_adding_targets]: /docs/CONTRIBUTING.md#adding-targets
 [docs_contrib_removing_targets]: /docs/CONTRIBUTING.md#removing-targets
 [docs_contrib_restoring_targets]: /docs/CONTRIBUTING.md#restoring-targets
 [ext_pypi]: https://pypi.org/project/sherlock-project/
 [ext_brew]: https://formulae.brew.sh/formula/sherlock
-

docs/install.md

@@ -37,13 +37,22 @@ Python
 pipx install sherlock-project
 ```
 
-### Build python package from source (useful for contributors)
+### Build live package from source (useful for contributors)
+
+Building an editable (or live) package links the entry point to your current directory, rather than to the standard install location. This is often useful when working with the code base, as changes are reflected immediately without reinstallation.
 
 ```bash
-# pipx is recommended, but pip may suffice if pipx is unavailable
-git clone https://github.com/sherlock-project/sherlock.git
-cd sherlock
-pipx install .
+# Assumes repository cloned, and pwd is repository root
+pipx install -e .
+```
+
+### Run package from source (no install)
+
+If you'd rather not install directly to your system, you can import the module at runtime with `-m`.
+
+```bash
+# Assumes repository cloned, and pwd is repository root
+python3 -m sherlock user123 user789
 ```
 
 <h2>

docs/pyproj/README.md

@@ -2,17 +2,12 @@
 
 <p align=center>
   <br>
-  <a href="https://sherlock-project.github.io/" target="_blank"><img src="https://user-images.githubusercontent.com/27065646/53551960-ae4dff80-3b3a-11e9-9075-cef786c69364.png"/></a>
+  <a href="https://sherlock-project.github.io/" target="_blank"><img src="https://www.kali.org/tools/sherlock/images/sherlock-logo.svg" width="25%"/></a>
   <br>
-  <span>Hunt down social media accounts by username across <a href="https://github.com/sherlock-project/sherlock/blob/master/sites.md">social networks</a></span>
+  <strong><span>Hunt down social media accounts by username across <a href="https://github.com/sherlock-project/sherlock/blob/master/sites.md">400+ social networks</a></span></strong>
+  <br><br>
+  <span>Additional documentation can be found at our <a href="https://github.com/sherlock-project/sherlock/">GitHub repository</a></span>
   <br>
-  <span>Additional documentation can be found on our <a href="https://github.com/sherlock-project/sherlock/">GitHub repository</a></span>
-  <br>
-</p>
-
-<p align="center">
-<img width="70%" height="70%" src="https://user-images.githubusercontent.com/27065646/219638267-a5e11090-aa6e-4e77-87f7-0e95f6ad5978.png"/>
-</a>
 </p>
 
 ## Usage
@@ -36,11 +31,12 @@ To search for more than one user:
 ```bash
 $ sherlock user1 user2 user3
 ```
+<br>
 
-## Star History
+___
 
-<picture>
-  <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=sherlock-project/sherlock&type=Date&theme=dark" />
-  <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=sherlock-project/sherlock&type=Date" />
-  <img alt="Sherlock Project Star History Chart" src="https://api.star-history.com/svg?repos=sherlock-project/sherlock&type=Date" />
-</picture>
+<br>
+<p align="center">
+<img width="70%" height="70%" src="https://user-images.githubusercontent.com/27065646/219638267-a5e11090-aa6e-4e77-87f7-0e95f6ad5978.png"/>
+</a>
+</p>

pyproject.toml

@@ -1,48 +1,65 @@
 [build-system]
-requires = ["setuptools >= 61.0"]
-build-backend = "setuptools.build_meta"
+requires = [ "poetry-core>=1.6.0", "poetry-dynamic-versioning>1.0.0,<2.0.0" ]
+build-backend = "poetry_dynamic_versioning.backend"
+# poetry-core 1.8 not available in .fc39. Can upgrade to 1.8.0 at .fc39 EOL
 
-[project.scripts]
-sherlock = "sherlock:main"
+[tool.poetry-dynamic-versioning]
+enable = false
+metadata = false
+strict = true
+vcs = "git"
+# Matched tags:
+# v0.0.0  followed by optional  -rc0 (release candidate)  OR  -b0 (public beta)
+pattern = "^v(?P<base>\\d+(?:\\.\\d+){2})(?:-(?P<stage>(?:rc|b)\\d+?))??$"
 
-[project.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-dynamic-versioning.substitution]
+folders = [ { path = "sherlock" } ]
 
-[project]
+[tool.poetry]
 name = "sherlock-project"
+version = "0.14.4"
+description = "Hunt down social media accounts by username across social networks"
+license = "MIT"
 authors = [
-    { name = "Siddharth Dushantha" }
+    "Siddharth Dushantha"
 ]
 maintainers = [
-    { name = "Matheus Felipe" },
-    { name = "Sondre Karlsen Dyrnes" },
-    { name = "Paul Pfeister" }
+    "Paul Pfeister",
+    "Matheus Felipe",
+    "Sondre Karlsen Dyrnes"
 ]
-description = "Hunt down social media accounts by username across social networks"
 readme = "docs/pyproj/README.md"
-# Do not set license to file. Causes issues with rpm packaging for some reason.
-license = {text = "MIT"}
-dynamic = ["dependencies", "version"]
+packages = [ { include = "sherlock"} ]
 keywords = [ "osint", "reconnaissance", "information gathering" ]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "Intended Audience :: Information Technology",
-    "License :: OSI Approved :: MIT License",
     "Natural Language :: English",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
     "Topic :: Security"
 ]
+homepage = "http://sherlock-project.github.io/"
+repository = "https://github.com/sherlock-project/sherlock.git"
+
 
-[tool.setuptools.dynamic]
-dependencies = { file = [ "requirements.txt" ] }
-version = { attr = "sherlock.__version__" }
+[tool.poetry.urls]
+"Bug Reporting" = "https://github.com/sherlock-project/sherlock/issues"
+"Contributors" = "https://github.com/sherlock-project/sherlock/graphs/contributors"
 
-[tool.setuptools]
-package-dir = {"" = "sherlock"}
+[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.setuptools.package-data]
-"*" = ["*.json"]
+[tool.poetry.scripts]
+sherlock = 'sherlock.sherlock:main'

sherlock/__main__.py

@@ -18,5 +18,5 @@
         print(f"Sherlock requires Python 3.6+\nYou are using Python {python_version}, which is not supported by Sherlock.")
         sys.exit(1)
 
-    import sherlock
+    from sherlock import sherlock
     sherlock.main()

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
 

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
 
@@ -510,9 +510,9 @@ def handler(signal_received, frame):
 
 def main():
     version_string = (
-        f"%(prog)s {__version__}\n"
-        + f"{requests.__description__}:  {requests.__version__}\n"
-        + f"Python:  {platform.python_version()}"
+        f"Sherlock  {__version__}\n"
+        + f"Requests  {requests.__version__}\n"
+        + f"Python    {platform.python_version()}"
     )
 
     parser = ArgumentParser(

sherlock/tests/base.py → tests/base.py

@@ -5,10 +5,10 @@
 import os
 import os.path
 import unittest
-import sherlock
-from result import QueryStatus
-from notify import QueryNotify
-from sites import SitesInformation
+from sherlock import sherlock
+from sherlock.result import QueryStatus
+from sherlock.notify import QueryNotify
+from sherlock.sites import SitesInformation
 import warnings
 
 
@@ -30,7 +30,7 @@ def setUp(self):
         warnings.simplefilter("ignore", ResourceWarning)
 
         # Create object with all information about sites we are aware of.
-        sites = SitesInformation(data_file_path=os.path.join(os.path.dirname(__file__), "../resources/data.json"))
+        sites = SitesInformation(data_file_path=os.path.join(os.path.dirname(__file__), "../sherlock/resources/data.json"))
 
         # Create original dictionary from SitesInformation() object.
         # Eventually, the rest of the code will be updated to use the new object

sherlock/tests/test_multiple_usernames.py → tests/test_multiple_usernames.py

@@ -1,8 +1,7 @@
-import importlib
 import unittest
 import sys
 sys.path.append('../')
-import sherlock as sh
+from sherlock import sherlock as sh
 
 checksymbols = []
 checksymbols = ["_", "-", "."]