Rename importable module

pyproject.toml

@@ -20,8 +20,8 @@ maintainers = [
     "Matheus Felipe <[email protected]>",
     "Sondre Karlsen Dyrnes <[email protected]>"
 ]
-readme = "docs/pyproj/README.md"
-packages = [ { include = "sherlock"} ]
+readme = "docs/pyproject/README.md"
+packages = [ { include = "sherlock_project"} ]
 keywords = [ "osint", "reconnaissance", "information gathering" ]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -32,7 +32,7 @@ classifiers = [
     "Programming Language :: Python :: 3",
     "Topic :: Security"
 ]
-homepage = "https://sherlock-project.github.io/"
+homepage = "https://sherlockproject.xyz/"
 repository = "https://github.com/sherlock-project/sherlock"
 
 
@@ -56,4 +56,4 @@ openpyxl = "^3.0.10"
 jsonschema = "^4.0.0"
 
 [tool.poetry.scripts]
-sherlock = 'sherlock.sherlock:main'
+sherlock = 'sherlock_project.sherlock:main'

sherlock/__main__.py → sherlock_project/__main__.py

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

sherlock/notify.py → sherlock_project/notify.py

@@ -3,7 +3,7 @@
 This module defines the objects for notifying the caller about the
 results of queries.
 """
-from sherlock.result import QueryStatus
+from sherlock_project.result import QueryStatus
 from colorama import Fore, Style
 import webbrowser
 

sherlock/sherlock.py → sherlock_project/sherlock.py

@@ -24,18 +24,18 @@
 __version__ = "0.14.4"
 del __version__
 
-from .__init__ import ( # noqa: E402
+from sherlock_project.__init__ import ( # noqa: E402
     __longname__,
     __version__
 )
 
 from requests_futures.sessions import FuturesSession    # noqa: E402
 from torrequest import TorRequest                       # noqa: E402
-from sherlock.result import QueryStatus                 # noqa: E402
-from sherlock.result import QueryResult                 # noqa: E402
-from sherlock.notify import QueryNotify                 # noqa: E402
-from sherlock.notify import QueryNotifyPrint            # noqa: E402
-from sherlock.sites import SitesInformation             # noqa: E402
+from sherlock_project.result import QueryStatus                 # noqa: E402
+from sherlock_project.result import QueryResult                 # noqa: E402
+from sherlock_project.notify import QueryNotify                 # noqa: E402
+from sherlock_project.notify import QueryNotifyPrint            # noqa: E402
+from sherlock_project.sites import SitesInformation             # noqa: E402
 from colorama import init                               # noqa: E402
 from argparse import ArgumentTypeError                  # noqa: E402
 

tests/conftest.py

@@ -2,22 +2,22 @@
 import json
 import urllib
 import pytest
-from sherlock.sites import SitesInformation
+from sherlock_project.sites import SitesInformation
 
 @pytest.fixture()
 def sites_obj():
-    sites_obj = SitesInformation(data_file_path=os.path.join(os.path.dirname(__file__), "../sherlock/resources/data.json"))
+    sites_obj = SitesInformation(data_file_path=os.path.join(os.path.dirname(__file__), "../sherlock_project/resources/data.json"))
     yield sites_obj
 
 @pytest.fixture(scope="session")
 def sites_info():
-    sites_obj = SitesInformation(data_file_path=os.path.join(os.path.dirname(__file__), "../sherlock/resources/data.json"))
+    sites_obj = SitesInformation(data_file_path=os.path.join(os.path.dirname(__file__), "../sherlock_project/resources/data.json"))
     sites_iterable = {site.name: site.information for site in sites_obj}
     yield sites_iterable
 
 @pytest.fixture(scope="session")
 def remote_schema():
-    schema_url: str = 'https://raw.githubusercontent.com/sherlock-project/sherlock/master/sherlock/resources/data.schema.json'
+    schema_url: str = 'https://raw.githubusercontent.com/sherlock-project/sherlock/master/sherlock_project/resources/data.schema.json'
     with urllib.request.urlopen(schema_url) as remoteschema:
         schemadat = json.load(remoteschema)
     yield schemadat

tests/few_test_basic.py

@@ -1,7 +1,7 @@
-import sherlock
+import sherlock_project
 
 #from sherlock.sites import SitesInformation
 #local_manifest = data_file_path=os.path.join(os.path.dirname(__file__), "../sherlock/resources/data.json")
 
 def test_username_via_message():
-    sherlock.__main__("--version")
+    sherlock_project.__main__("--version")

tests/sherlock_interactives.py

@@ -25,7 +25,7 @@ def walk_sherlock_for_files_with(pattern: str) -> list:
         """Check all files within the Sherlock package for matching patterns"""
         pattern:re.Pattern = re.compile(pattern)
         matching_files:list[str] = []
-        for root, dirs, files in os.walk("sherlock"):
+        for root, dirs, files in os.walk("sherlock_project"):
             for file in files:
                 file_path = os.path.join(root,file)
                 if "__pycache__" in file_path:

tests/test_manifest.py

@@ -5,8 +5,8 @@
 
 def test_validate_manifest_against_local_schema():
     """Ensures that the manifest matches the local schema, for situations where the schema is being changed."""
-    json_relative: str = '../sherlock/resources/data.json'
-    schema_relative: str = '../sherlock/resources/data.schema.json'
+    json_relative: str = '../sherlock_project/resources/data.json'
+    schema_relative: str = '../sherlock_project/resources/data.schema.json'
 
     json_path: str = os.path.join(os.path.dirname(__file__), json_relative)
     schema_path: str = os.path.join(os.path.dirname(__file__), schema_relative)
@@ -22,7 +22,7 @@ def test_validate_manifest_against_local_schema():
 @pytest.mark.online
 def test_validate_manifest_against_remote_schema(remote_schema):
     """Ensures that the manifest matches the remote schema, so as to not unexpectedly break clients."""
-    json_relative: str = '../sherlock/resources/data.json'
+    json_relative: str = '../sherlock_project/resources/data.json'
     json_path: str = os.path.join(os.path.dirname(__file__), json_relative)
 
     with open(json_path, 'r') as f:

tests/test_probes.py

@@ -2,9 +2,9 @@
 import random
 import string
 import re
-from sherlock.sherlock import sherlock
-from sherlock.notify import QueryNotify
-from sherlock.result import QueryStatus
+from sherlock_project.sherlock import sherlock
+from sherlock_project.notify import QueryNotify
+from sherlock_project.result import QueryStatus
 #from sherlock_interactives import Interactives
 
 

tests/test_ux.py

@@ -1,5 +1,5 @@
 import pytest
-from sherlock import sherlock
+from sherlock_project import sherlock
 from sherlock_interactives import Interactives
 from sherlock_interactives import InteractivesSubprocessError
 

tests/test_version.py

@@ -1,17 +1,17 @@
 import os
 from sherlock_interactives import Interactives
-import sherlock
+import sherlock_project
 
 def test_versioning() -> None:
     # Ensure __version__ matches version presented to the user
-    assert sherlock.__version__ in Interactives.run_cli("--version")
+    assert sherlock_project.__version__ in Interactives.run_cli("--version")
     # Ensure __init__ is single source of truth for __version__ in package
     # Temporarily allows sherlock.py so as to not trigger early upgrades
     found:list = Interactives.walk_sherlock_for_files_with(r'__version__ *= *')
     expected:list = [
         # Normalization is REQUIRED for Windows ( / vs \ )
-        os.path.normpath("sherlock/__init__.py"),
-        os.path.normpath("sherlock/sherlock.py"),
+        os.path.normpath("sherlock_project/__init__.py"),
+        os.path.normpath("sherlock_project/sherlock.py"),
     ]
     # Sorting is REQUIRED for Mac
     assert sorted(found) == sorted(expected)

tox.ini

@@ -18,7 +18,7 @@ deps =
     pytest
 allowlist_externals = coverage
 commands =
-    coverage run --source=sherlock --module pytest -v
+    coverage run --source=sherlock_project --module pytest -v
     coverage report --show-missing
 
 [testenv:offline]