Added v0.2.1 code

Descent098 · Descent098 · commit 8f9c2447540f · 2021-09-01T12:09:21.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,10 +1,27 @@
 # Changelog
 
+## V0.2.1; September 1st 2021
+
+Fixing bugs found after release
+
+**Bug fixes**:
+
+- Fixed error on ```sws.youtube._request_path()``` where it would fail if no tkinter display variable is set
+- Fixed bug with retrieval of domain records where an unbound variable would exist if the request hung
+- Fixed issue where no usage would print when using DNS command without any args
+- Fixed issue where no usage would print when using SSL command without any args
+- Fixed issue with DNS lookups where on slow connections it would hang waiting for records to load
+
+**Documentation Improvements**:
+
+- Fixed some spelling errors and text duplication
+- Improved some of the readme and Usage docs explanations
+
 ## V0.2.0; September 1st 2021
 
 Focus for this release was to revamp the package and add a ton of functionality.
 
-Features:
+**Features**:
 
 - Simplified and streamlined `redirect.trace()`
 - Added Bash autocomplete for ease of use on *nix systems
@@ -14,7 +31,7 @@ Features:
 - Added `__main__.py` file for direct cli invocation (`python -m sws`)
 - Added logging to existing functions, and all new functions
 
-Documentation Improvements:
+**Documentation Improvements**:
 - Added additional source, docs, and roadmap links to ```setup.py``` for PyPi
 - Added github templates (for issues and PR's), and testing pipeline
 - Added testing suite for majority of library functions
@@ -25,7 +42,7 @@ Documentation Improvements:
 
 Initial release went out on github and PyPi. Ported functionality from kuws package.
 
-Features:
+**Features**:
 
 - Trace redirects
 - Download YouTube videos directly from command line
diff --git a/README.md b/README.md
@@ -22,6 +22,19 @@
 
 A command line interface, and set of scripts for common web tasks.
 
+## Quick-start
+
+### Installation
+
+#### From PyPi
+
+run ```pip install sws``` or ```sudo pip3 install sws```.
+
+#### From source
+
+1. Clone the github repo ([https://github.com/Descent098/sws](https://github.com/Descent098/sws))
+2. cd into the 'sws' root directory (where setup.py is) and run ```pip install .``` or ```sudo pip3 install . ```
+
 ## Additional Documentation
 
 API Documentation can be found at [https://kieranwood.ca/sws/](https://kieranwood.ca/sws/)
@@ -30,7 +43,20 @@ User Documentation for the cli can be found at [https://sws.readthedocs.io](http
 
 ## What does sws do?
 
-sws is both a cli, and an API with the goal of making common web development tasks simple.
+`sws` is both a cli, and an API with the goal of making common web development tasks simple. 
+
+Specifically the API is designed to:
+
+1. Be a **cross-platform** utility API
+2. Give sensible high-level functions for common tasks
+3. Provide useful constants such as a list of dns record types
+4. Provide a set of utility classes for common tasks (such as downloads)
+
+The CLI is designed to:
+
+1. Provide a **cross-platform** set of tools
+2. Provide a toolbox for ease of use tasks so you don't need to know dozens of commands
+3. Make doing simple tasks simpler
 
 ## Features & Roadmap
 
@@ -75,19 +101,6 @@ Really it can be used by anyone, but here are the most typial use cases:
 - People learning webdev; Sometimes getting access to tooling while learning webdev can be difficult, this can be a one-stop shop for lots of functionality
 - Scripters; people who are looking to use sws functionality in their own projects
 
-## Quick-start
-
-### Installation
-
-#### From PyPi
-
-run ```pip install sws``` or ```sudo pip3 install sws```.
-
-#### From source
-
-1. Clone the github repo ([https://github.com/Descent098/sws](https://github.com/Descent098/sws))
-2. cd into the 'sws' root directory (where setup.py is) and run ```pip install .``` or ```sudo pip3 install . ```
-
 ## Development-Contribution guide
 
 See [Contribution guide](https://sws.readthedocs.io/contribution-guide/) for details about helping with development.
diff --git a/docs/index.md b/docs/index.md
@@ -1,5 +1,4 @@
 
-
 ![sws-banner](./img/sws-banner.png)
 
 # Welcome to the sws documentation!
@@ -8,6 +7,23 @@
 
 sws is a utility I wrote with the intention of implementing some common web scripts into one cohesive library. it is primarily intended to be used as a standalone script, but it can also be used as an API. 
 
+## What does sws do?
+
+`sws` is both a cli, and an API with the goal of making common web development tasks simple. 
+
+Specifically the API is designed to:
+
+1. Be a **cross-platform** utility API
+2. Give sensible high-level functions for common tasks
+3. Provide useful constants such as a list of dns record types
+4. Provide a set of utility classes for common tasks (such as downloads)
+
+The CLI is designed to:
+
+1. Provide a **cross-platform** set of tools
+2. Provide a toolbox for ease of use tasks so you don't need to know dozens of commands
+3. Make doing simple tasks simpler
+
 ## Installation
 
 ### From PyPi
@@ -21,11 +37,8 @@ run ```pip install sws``` or ```sudo pip3 install sws```.
 
 
 ## Script Usage
-You can validate it is installed properly by typing ```sws``` into your terminal, the output should look like this:
 
-Additional details can be found at the documentation available on [https://sws.readthedocs.io/](https://sws.readthedocs.io/).
-
-You can validate it is installed properly by typing ```sws``` into your terminal, the output should look like this:
+You can validate if the script is installed properly by typing ```sws``` into your terminal, the output should look like this:
 
 ```bash
 Super Web Scripts; A command line interface, and set of scripts for web tasks.
@@ -224,4 +237,3 @@ Details on API usage can be found here [https://kieranwood.ca/sws/](https://kier
 
 
 You can also build local API docs by installing [pdoc3](https://pdoc3.github.io/pdoc/) (```pip install pdoc3``` or ```sudo pip3 install pdoc3```), and then running ```pdoc sws --http localhost:8080```. Go to a browser and type in [http://localhost:8080/sws/utilities/](http://localhost:8080/sws/utilities/)
-
diff --git a/setup.py b/setup.py
@@ -4,6 +4,7 @@
 def get_content(*filename:str) -> str:
     """ Gets the content of a file or files and returns
     it/them as a string
+
     Parameters
     ----------
     filename : (str)
@@ -24,7 +25,7 @@ def get_content(*filename:str) -> str:
 
 setuptools.setup(
     name="sws",
-    version="0.2.0",
+    version="0.2.1",
     author="Kieran Wood",
     author_email="kieran@canadiancoding.ca",
     description="An API & command line interface, for common web tasks",
diff --git a/sws/cli.py b/sws/cli.py
@@ -79,6 +79,9 @@ def main():
             print(f"SSL cert on domain {args['<hostname>']} Expires on: {check_ssl_expiry(args['<hostname>'])}")
         if args["--cert"]:  # If -c or --cert is specified
             pprint(get_ssl_cert(args['<hostname>']))
+        if not (args["--expiry"] or args["--cert"]):
+            print(usage)
+            sys.exit()
 
     elif args["redirects"]:  # Begin parsing for redirects subcommand
         if args["<ignored>"]:
@@ -94,6 +97,7 @@ def main():
 
     elif args["domains"]:  # Begin parsing for ssl subcommand
         domain_details = get_domain_info(args["<domain>"])
+
         if args["--expiry"]:  # If -e or --expiry is specified
             expiry_date = domain_details["expiration_date"]
             print(f"Domain {args['<domain>']} set to expire on {expiry_date.strftime('%d-%b-%Y %H:%M:%S')}")
@@ -103,10 +107,16 @@ def main():
             else:
                 print(f"{args['<domain>']} is not registered")
         if args["--details"]:
+            if not domain_details['creation_date']:
+                print(f"Domain {args['<domain>']} was not registered")
             pprint(domain_details)
         if args["--available"]:
             print(f"Domain {args['<domain>']} is available" if domain_availability(domain_details)[1] else f"{domain_availability(domain_details)[0]}")
 
+        if not (args["--expiry"] or args["--registrar"] or args["--details"] or args["--available"]):
+            print(usage)
+            sys.exit()
+
     else:
         print(usage)
         if not os.name == "nt":  # Generate bash autocomplete
diff --git a/sws/dns_utilities.py b/sws/dns_utilities.py
@@ -145,13 +145,17 @@ def get_dns_records(domain:str, as_dict:bool=False) -> Union[List[str], Dict[str
         logging.info(f"Stripping http:// protocol from {domain}")
         domain = domain.replace("http://", "")
 
+    print(f"Beginning dns query to {domain} this may take up to 5 mins depending on connection speed")
     if as_dict:
         logging.debug("Beginning itteration of record types, and setting up result dictionary")
         result = {}
         for record_type in RECORD_TYPES:
             logging.info(f"Parsing record: {record_type}")
             try:
-                response = dns.resolver.resolve(domain, rdtype=record_type)
+                try:
+                    response = dns.resolver.resolve(domain, rdtype=record_type, lifetime=4.5)
+                except dns.exception.Timeout:
+                    ... # Record doesn't exist
                 for record_data in response:
                     logging.info(f"Parsing record response {record_type}: {record_data.to_text()}")
                     if record_type == dns.rdatatype.RdataType.HTTPS:
@@ -176,14 +180,17 @@ def get_dns_records(domain:str, as_dict:bool=False) -> Union[List[str], Dict[str
         for record_type in RECORD_TYPES:
             logging.info(f"Parsing record: {record_type}")
             try:
-                response = dns.resolver.resolve(domain, rdtype=record_type)
+                try:
+                    response = dns.resolver.resolve(domain, rdtype=record_type, lifetime=4.5)
+                except dns.exception.Timeout:
+                    ... # Record doesn't exist
                 for record_data in response:
                     logging.info(f"Parsing record response {record_type}: {record_data.to_text()}")
                     result.append(f"{record_type.name}: {record_data.to_text()}")
             except Exception:
                 ... # Record doesn't exist
     if not result:
-        raise ValueError(f"Domain {domain} did not have any configured records, please check ")
+        raise ValueError(f"Domain {domain} did not have any configured records, please check spelling")
     logging.info(f"Exiting get_dns_records() and returning {result}")
     return result
 
diff --git a/sws/domains.py b/sws/domains.py
@@ -136,41 +136,58 @@ def get_domain_info(domain: str) -> dict:
     #         raise e
 
     # Parse response
-    if not domain_details:  # If the domain is not registered
-        logging.info(f"""Exiting get_domain_info() and returning {{'creation_date': False,
-                'expiration_date': False,
-                'last_updated': False,
-                'name': {domain},
-                'name_servers': False,
-                'registrant_cc': False,
-                'registrar': False}}""")
-        return {'creation_date': False,
-                'expiration_date': False,
-                'last_updated': False,
-                'name': domain,
-                'name_servers': False,
-                'registrant_cc': False,
-                'registrar': False}
-
-    elif domain_details is None:  # If the domain is not registered and query completely failed
+    try:
+        if domain_details is None:  # If the domain is not registered and query completely failed
+            logging.info(f"""Exiting get_domain_info() and returning {{'creation_date': False,
+                    'expiration_date': False,
+                    'last_updated': False,
+                    'name': {domain},
+                    'name_servers': False,
+                    'registrant_cc': False,
+                    'registrar': False}}""")
+            return {'creation_date': False,
+                    'expiration_date': False,
+                    'last_updated': False,
+                    'name': domain,
+                    'name_servers': False,
+                    'registrant_cc': False,
+                    'registrar': False}
+
+        elif not domain_details:  # If the domain is not registered
+            logging.info(f"""Exiting get_domain_info() and returning {{'creation_date': False,
+                    'expiration_date': False,
+                    'last_updated': False,
+                    'name': {domain},
+                    'name_servers': False,
+                    'registrant_cc': False,
+                    'registrar': False}}""")
+            return {'creation_date': False,
+                    'expiration_date': False,
+                    'last_updated': False,
+                    'name': domain,
+                    'name_servers': False,
+                    'registrant_cc': False,
+                    'registrar': False}
+
+        else:  # If there was domain info
+            logging.info(f"Exiting get_domain_info() and returning {vars(domain_details)}")
+            return vars(domain_details)
+
+    except UnboundLocalError: # When the variable never gets assigned after a failure
         logging.info(f"""Exiting get_domain_info() and returning {{'creation_date': False,
-                'expiration_date': False,
-                'last_updated': False,
-                'name': {domain},
-                'name_servers': False,
-                'registrant_cc': False,
-                'registrar': False}}""")
+                    'expiration_date': False,
+                    'last_updated': False,
+                    'name': {domain},
+                    'name_servers': False,
+                    'registrant_cc': False,
+                    'registrar': False}}""")
         return {'creation_date': False,
-                'expiration_date': False,
-                'last_updated': False,
-                'name': domain,
-                'name_servers': False,
-                'registrant_cc': False,
-                'registrar': False}
-
-    else:  # If there was domain info
-        logging.info(f"Exiting get_domain_info() and returning {vars(domain_details)}")
-        return vars(domain_details)
+                    'expiration_date': False,
+                    'last_updated': False,
+                    'name': domain,
+                    'name_servers': False,
+                    'registrant_cc': False,
+                    'registrar': False}
 
 
 def domain_availability(domain_query: dict) -> tuple:
diff --git a/sws/youtube.py b/sws/youtube.py
@@ -28,11 +28,15 @@
 def _request_path():
     """Prompts user for the link to a youtube video, and path of where to download the video to"""
     logging.info("Entering _request_path()")
-    root = tk.Tk()
-    root.withdraw()
-    file_path = str(filedialog.askdirectory(
-        title="Select Video Output directory",
-        mustexist=False))
+    try:
+        root = tk.Tk()
+        root.withdraw()
+        file_path = str(filedialog.askdirectory(
+            title="Select Video Output directory",
+            mustexist=False))
+    except Exception as e:
+        print(f"Unable to start path selection GUI due to {e}, defualting downloading to current working directory {os.path.abspath('.')}")
+        file_path = os.path.abspath(".")
     return file_path
 
 
