Switch to Poetry

sherlock-project · May 16, 2024 · fba6432 · fba6432
1 parent 0ecb496
commit fba6432
Show file tree

Hide file tree

Showing 7 changed files with 56 additions and 53 deletions.
diff --git a/docs/README.md b/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
 

diff --git a/docs/pyproj/README.md b/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>
diff --git 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]
+[tool.poetry]
 name = "sherlock-project"
+version = "0.0.0"
+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",
@@ -37,12 +33,24 @@ classifiers = [
     "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.setuptools.package-data]
-"*" = ["*.json"]
+[tool.poetry.scripts]
+sherlock = 'sherlock.sherlock:main'
diff --git 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
@@ -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
@@ -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
@@ -1,4 +1,3 @@
-import importlib
 import unittest
 import sys
 sys.path.append('../')