add support for pip install

.gitignore

@@ -2,4 +2,6 @@
 *.rdb
 *sublime*
 venv/
-scripts/
+/scripts/
+build/
+*.egg-info

pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "recon-ng"
+description = "Open Source Intelligence gathering tool"
+authors = [{ name = "Tim Tomes" }]
+requires-python = ">=3.6"
+readme = "README.md"
+license = { file = "LICENSE" }
+dynamic = ["dependencies", "version"]
+
+[tool.setuptools.dynamic]
+dependencies = { file = "REQUIREMENTS" }
+version = { attr = "recon._version.__version__" }
+
+[project.scripts]
+recon-cli = "recon.scripts.cli:main"
+recon-ng = "recon.scripts.ng:main"
+recon-web = "recon.scripts.web:main"
+
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"

recon/_version.py

@@ -0,0 +1 @@
+../VERSION

recon/core/base.py

@@ -17,9 +17,7 @@
 # import framework libs
 from recon.core import framework
 from recon.core.constants import BANNER, BANNER_SMALL
-
-# set the __version__ variable based on the VERSION file
-exec(open(os.path.join(Path(os.path.abspath(__file__)).parents[2], 'VERSION')).read())
+from recon._version import __version__
 
 # using stdout to spool causes tab complete issues
 # therefore, override print function

recon-cli → recon/scripts/cli.py

@@ -68,22 +68,23 @@ def recon_cli(args):
         # run the module
         y.do_run(None)
 
-description = f"%(prog)s - {base.__author__}"
-parser = argparse.ArgumentParser(description=description)
-parser.add_argument('-w', help='load/create a workspace', metavar='workspace', dest='workspace', action='store')
-parser.add_argument('-C', help='runs a command at the global context', metavar='command', dest='global_commands' ,default=[], action='append')
-parser.add_argument('-c', help='runs a command at the module context (pre-run)', metavar='command', dest='module_commands' ,default=[], action='append')
-parser.add_argument('-G', help='show available global options', dest='gshow', default=False, action='store_true')
-parser.add_argument('-g', help='set a global option (can be used more than once)', metavar='name=value', dest='goptions', default=[], action='append')
-parser.add_argument('-M', help='show modules', dest='show_modules', default=False, action='store_true')
-parser.add_argument('-m', help='specify the module', metavar='module', dest='module', action='store')
-parser.add_argument('-O', help='show available module options', dest='show', default=False, action='store_true')
-parser.add_argument('-o', help='set a module option (can be used more than once)', metavar='name=value', dest='options', default=[], action='append')
-parser.add_argument('-x', help='run the module', dest='run', default=False, action='store_true')
-parser.add_argument('--no-version', help='disable version check', dest='check', default=True, action='store_false')
-parser.add_argument('--no-analytics', help='disable analytics reporting', dest='analytics', default=True, action='store_false')
-parser.add_argument('--no-marketplace', help='disable remote module management', dest='marketplace', default=True, action='store_false')
-parser.add_argument('--stealth', help='disable all passive requests (--no-*)', dest='stealth', default=False, action='store_true')
-parser.add_argument('--version', help='displays the current version', action='version', version=base.__version__)
-args = parser.parse_args()
-recon_cli(args)
+def main():
+    description = f"%(prog)s - {base.__author__}"
+    parser = argparse.ArgumentParser(description=description)
+    parser.add_argument('-w', help='load/create a workspace', metavar='workspace', dest='workspace', action='store')
+    parser.add_argument('-C', help='runs a command at the global context', metavar='command', dest='global_commands' ,default=[], action='append')
+    parser.add_argument('-c', help='runs a command at the module context (pre-run)', metavar='command', dest='module_commands' ,default=[], action='append')
+    parser.add_argument('-G', help='show available global options', dest='gshow', default=False, action='store_true')
+    parser.add_argument('-g', help='set a global option (can be used more than once)', metavar='name=value', dest='goptions', default=[], action='append')
+    parser.add_argument('-M', help='show modules', dest='show_modules', default=False, action='store_true')
+    parser.add_argument('-m', help='specify the module', metavar='module', dest='module', action='store')
+    parser.add_argument('-O', help='show available module options', dest='show', default=False, action='store_true')
+    parser.add_argument('-o', help='set a module option (can be used more than once)', metavar='name=value', dest='options', default=[], action='append')
+    parser.add_argument('-x', help='run the module', dest='run', default=False, action='store_true')
+    parser.add_argument('--no-version', help='disable version check', dest='check', default=True, action='store_false')
+    parser.add_argument('--no-analytics', help='disable analytics reporting', dest='analytics', default=True, action='store_false')
+    parser.add_argument('--no-marketplace', help='disable remote module management', dest='marketplace', default=True, action='store_false')
+    parser.add_argument('--stealth', help='disable all passive requests (--no-*)', dest='stealth', default=False, action='store_true')
+    parser.add_argument('--version', help='displays the current version', action='version', version=base.__version__)
+    args = parser.parse_args()
+    recon_cli(args)

recon-ng → recon/scripts/ng.py

@@ -44,15 +44,16 @@ def recon_ui(args):
     except KeyboardInterrupt:
         print('')
 
-description = f"%(prog)s - {base.__author__}"
-parser = argparse.ArgumentParser(description=description)
-parser.add_argument('-w', help='load/create a workspace', metavar='workspace', dest='workspace', action='store')
-parser.add_argument('-r', help='load commands from a resource file', metavar='filename', dest='script_file', action='store')
-parser.add_argument('--no-version', help='disable version check', dest='check', default=True, action='store_false')
-parser.add_argument('--no-analytics', help='disable analytics reporting', dest='analytics', default=True, action='store_false')
-parser.add_argument('--no-marketplace', help='disable remote module management', dest='marketplace', default=True, action='store_false')
-parser.add_argument('--stealth', help='disable all passive requests (--no-*)', dest='stealth', default=False, action='store_true')
-parser.add_argument('--accessible', help='Use accessible outputs when available', dest='accessible', default=False, action='store_true')
-parser.add_argument('--version', help='displays the current version', action='version', version=base.__version__)
-args = parser.parse_args()
-recon_ui(args)
+def main():
+    description = f"%(prog)s - {base.__author__}"
+    parser = argparse.ArgumentParser(description=description)
+    parser.add_argument('-w', help='load/create a workspace', metavar='workspace', dest='workspace', action='store')
+    parser.add_argument('-r', help='load commands from a resource file', metavar='filename', dest='script_file', action='store')
+    parser.add_argument('--no-version', help='disable version check', dest='check', default=True, action='store_false')
+    parser.add_argument('--no-analytics', help='disable analytics reporting', dest='analytics', default=True, action='store_false')
+    parser.add_argument('--no-marketplace', help='disable remote module management', dest='marketplace', default=True, action='store_false')
+    parser.add_argument('--stealth', help='disable all passive requests (--no-*)', dest='stealth', default=False, action='store_true')
+    parser.add_argument('--accessible', help='Use accessible outputs when available', dest='accessible', default=False, action='store_true')
+    parser.add_argument('--version', help='displays the current version', action='version', version=base.__version__)
+    args = parser.parse_args()
+    recon_ui(args)

recon-web → recon/scripts/web.py

@@ -10,5 +10,5 @@
 args = parser.parse_args()
 
 app = create_app()
-if __name__ == '__main__':
+def main():
     app.run(host=args.host, port=args.port)