Merge pull request #2116 from ppfeister/feature/pyproject

Prepare PyProject for PyPi

.gitignore

@@ -14,6 +14,9 @@ __pycache__/
 # Pip
 src/
 
+# Pip / PyProject Devel & Installation
+*.egg-info/
+
 # Jupyter Notebook
 .ipynb_checkpoints
 *.ipynb

Dockerfile

@@ -18,9 +18,9 @@ LABEL org.label-schema.vcs-ref=$VCS_REF \
 COPY --from=build /wheels /wheels
 COPY . /opt/sherlock/
 
-RUN pip3 install --no-cache-dir -r requirements.txt -f /wheels \
+RUN pip3 install --no-cache-dir . -f /wheels \
   && rm -rf /wheels
 
 WORKDIR /opt/sherlock/sherlock
 
-ENTRYPOINT ["python", "sherlock.py"]
+ENTRYPOINT ["sherlock"]

README.md

@@ -25,20 +25,13 @@
 ## Installation
 
 ```console
-# clone the repo
-$ git clone https://github.com/sherlock-project/sherlock.git
-
-# change the working directory to sherlock
-$ cd sherlock
-
-# install the requirements
-$ python3 -m pip install -r requirements.txt
+pip install git+https://github.com/sherlock-project/sherlock.git
 ```
 
 ## Usage
 
 ```console
-$ python3 sherlock --help
+$ 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]

pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools >= 61.0"]
+build-backend = "setuptools.build_meta"
+
+[project.scripts]
+sherlock = "sherlock:main"
+
+[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"
+authors = [
+    { name = "Sherlock Project" }
+]
+maintainers = [
+    { name = "Siddharth Dushantha" },
+    { name = "Matheus Felipe" },
+    { name = "Sondre Karlsen Dyrnes" },
+    { name = "Paul Pfeister" }
+]
+description = "Hunt down social media accounts by username across social networks"
+readme = "README.md"
+license = {file = "LICENSE"}
+dynamic = ["dependencies", "version"]
+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 :: Communications",
+    "Topic :: Security"
+]
+
+[tool.setuptools.dynamic]
+dependencies = { file = [ "requirements.txt" ] }
+version = { attr = "sherlock.__version__" }
+
+[tool.setuptools]
+package-dir = {"" = "sherlock"}

setup.cfg

@@ -0,0 +1,4 @@
+[metadata]
+name = Sherlock
+author = Sherlock Project
+url = http://sherlock-project.github.io/