Create new URL encoding function to align with SEC API

README.md

@@ -38,26 +38,49 @@ This is a command line tool that takes a search query, queries a server, and dow
 
 ### Examples
 
-```bash
-# Display help message describing all supported arguments along with their usage, aliases and eventual default values (type q to exit)
+Display help message describing all supported arguments along with their usage, aliases and eventual default values (type `q` to exit)
+
+```shell
 edgar-tool text_search --help
+```
+
+Basic usage (defaults to searching the last 5 years of records)
 
-# Basic usage (defaults to searching the last 5 years of records)
+```shell
 edgar-tool text_search John Doe
+```
+
+You can wrap a phrase in quotes if you want an exact match.
+This works in both POSIX-compliant shells (Linux/Bash) and Windows PowerShell environments.
 
-# Basic usage with a combination of exact and partial search parameters
-edgar-tool text_search \"John Doe\" Pharmaceuticals Chemicals
+For example, the following usage will search for the exact phrase `"John Doe"` and treat `Pharmaceuticals` and
+`Chemicals` as partial search parameters.
+
+```shell
+edgar-tool text_search "John Doe" Pharmaceuticals Chemicals
+```
 
-# Usage with date range and export to custom CSV file
+Usage with date range and export to custom CSV file
+
+```shell
 edgar-tool text_search Tsunami Hazards --start_date "2021-01-01" --end_date "2021-12-31" --output "results.csv"
+```
 
-# Usage with a partial set of filing forms + single forms
+### Usage with a partial set of filing forms + single forms
+
+```
 edgar-tool text_search Hurricane Damage --filing_form "registration_statements" --single_forms "['1-K', '1-SA']"
+```
+
+Usage specifying the location of incorporation
 
-# Usage specifying the location of incorporation
+```shell
 edgar-tool text_search oil --inc_in "Egypt"
+```
+
+More advanced usage specifying more arguments, with export to JSON
 
-# More advanced usage specifying more arguments, with export to JSON
+```shell
 edgar-tool text_search Volcano Monitoring --start_date "2021-01-01" --end_date "2021-12-31" --output "results.json"\
           --filing_form "all_annual_quarterly_and_current_reports" --entity_id "0001030717" \
           --min_wait 5.0 --max_wait 7.0 --retries 3

edgar_tool/main.py → edgar_tool/__main__.py

@@ -2,9 +2,9 @@
 import fire
 
 
-def main_entrypoint():
+def main():
     fire.Fire(SecEdgarScraperCli)
 
 
 if __name__ == "__main__":
-    main_entrypoint()
+    main()

edgar_tool/cli.py

@@ -57,15 +57,16 @@ def _validate_text_search_args(
     ):
         raise ValueError(
             f"Filing form group must be one of: {'; '.join(TEXT_SEARCH_FILING_VS_MAPPING_CATEGORIES_MAPPING.keys())}"
-    )
+        )
     if single_forms:
-        single_list = [item for sublist in TEXT_SEARCH_CATEGORY_FORM_GROUPINGS.values() for item in
-                       sublist]
+        single_list = [
+            item
+            for sublist in TEXT_SEARCH_CATEGORY_FORM_GROUPINGS.values()
+            for item in sublist
+        ]
         invalid_forms = [form for form in single_forms if form not in single_list]
         if invalid_forms:
-            raise ValueError(
-                f"Single forms must be one or more of: {single_list}"
-            )
+            raise ValueError(f"Single forms must be one or more of: {single_list}")
 
 
 class SecEdgarScraperCli:
@@ -135,7 +136,9 @@ def text_search(
         scraper.text_search(
             keywords=keywords,
             entity_id=entity_id,
-            filing_form=TEXT_SEARCH_FILING_VS_MAPPING_CATEGORIES_MAPPING.get(filing_form),
+            filing_form=TEXT_SEARCH_FILING_VS_MAPPING_CATEGORIES_MAPPING.get(
+                filing_form
+            ),
             single_forms=single_forms,
             start_date=start_date,
             end_date=end_date,
@@ -144,7 +147,7 @@ def text_search(
             retries=retries,
             destination=output,
             peo_in=peo_in,
-            inc_in=inc_in
+            inc_in=inc_in,
         )
 
     @staticmethod