Merge pull request #2 from markgacoka/requirements

Add requirements to setup, add packagename to setup

r3c0n/subdomain_scan.py → r3c0n.py

@@ -1,5 +1,6 @@
-from scripts.anubis import anubis_script
 import yarl
+from typing import List
+from scripts.anubis import anubis_script
 
 class Clean:
     def cleanup(subdomain_lst: List[str]) -> List[str]:

r3c0n/scripts/anubis.py → scripts/anubis.py

@@ -18,6 +18,18 @@ def GET_UA():
     return random.choice(uastrings)
 
 def anubis_script(domain):
+    """Returns the list of subdomains from the Anuibis Database.
+
+    Args:
+        domain: An inscope domain in which the subdomains are required.
+    Returns:
+        A list of subdomains extracted from the Anubis database.
+    Raises:
+        RequestError: Raised on wrong request type.
+        HTTPError: Raised on malformed HTTP request.
+        ConnectionError: Raised when fails to connect to the server.
+        TimeoutError: Raised when request takes too long to come back.
+    """
     anubis = []
     headers = {"User-Agent": GET_UA(), "Content-Type": "application/json"}
     try:

setup.py

@@ -5,6 +5,9 @@ def read_file(filename):
     with open(os.path.join(os.path.dirname(__file__), filename)) as file:
         return file.read()
 
+with open('requirements.txt') as f:
+    required = f.read().splitlines()
+
 VERSION="0.0.1"
 DESCRIPTION="A tool for performing reconnaissance on web targets in Python."
 LONG_DESCRIPTION="A tool for finding subdomain and directory information for various web targets."
@@ -22,13 +25,13 @@ def read_file(filename):
     url="https://github.com/markgacoka/r3c0n",
     download_url="https://github.com/markgacoka/r3c0n/releases",
     packages=find_packages('r3c0n'),
-    install_requires=[''],
+    install_requires=required,
     py_modules=['r3c0n'],
     keywords='cybersecurity, reconnaissance, scanning, automation',
     classifiers=[
         "Development Status :: 1 - Planning",
         "Intended Audience :: Developers",
-        "License :: OSI Approved :: MIT",
+        "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
         "Programming Language :: Python :: 3",
         "Topic :: Security"