Added opensearch setup

README.md

@@ -1,5 +1,5 @@
 # Shoogle
-Get Google search results, but without any ads, javascript, or AMP links. Easily deployable via Docker, and customizable with a single config text file. Quick and simple to integrate as a primary search engine replacement on both desktop and mobile. 
+Get Google search results, but without any ads, javascript, or AMP links. Easily deployable via Docker, and customizable with a single config text file. Quick and simple to integrate as a primary search engine replacement on both desktop and mobile.
 
 ## Prerequisites
 - Docker ([Windows](https://docs.docker.com/docker-for-windows/install/), [macOS](https://docs.docker.com/docker-for-mac/install/), [Ubuntu](https://docs.docker.com/engine/install/ubuntu/), [other Linux distros](https://docs.docker.com/engine/install/binaries/))
@@ -20,7 +20,7 @@ heroku login
 heroku container:login
 git clone https://github.com/benbusby/shoogle.git
 cd shoogle
-heroku create 
+heroku create
 heroku container:push web
 heroku container:release web
 heroku open
@@ -31,8 +31,9 @@ TODO
 
 ## Extra Steps
 - Set Shoogle as your primary search engine
+  - From the main shoogle folder, run `python opensearch.py "\<your app url\>"`
   - Firefox (Desktop)
-    - Navigate to your running app's url, and click the 3 dot menu in the address bar. At the bottom, there should be an option to "Add Search Engine". Once you've clicked this, open your Firefox Preferences menu, click "Search" in the left menu, and use the available dropdown to select "Shoogle" from the list.
+    - Navigate to your app's url, and click the 3 dot menu in the address bar. At the bottom, there should be an option to "Add Search Engine". Once you've clicked this, open your Firefox Preferences menu, click "Search" in the left menu, and use the available dropdown to select "Shoogle" from the list.
   - Firefox (Mobile)
     - In the mobile app Settings page, tap "Search" within the "General" section. There should be an option titled "Add Search Engine" to select. It should prompt you to enter a title and search query url - use the following elements to fill out the form:
       - Title: "Shoogle"

app/static/opensearch.template

@@ -1,14 +1,13 @@
 <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"
                        xmlns:moz="http://www.mozilla.org/2006/browser/search/">
-  <ShortName>[SNK]</ShortName>
+  <ShortName>Shoogle</ShortName>
-  <Description>[Search engine full name and summary]</Description>
+  <Description>Shoogle: A lightweight, deployable Google search proxy for desktop/mobile that removes Javascript, AMP links, and ads</Description>
-  <InputEncoding>[UTF-8]</InputEncoding>
+  <InputEncoding>UTF-8</InputEncoding>
-  <Image width="16" height="16" type="image/x-icon">[https://example.com/favicon.ico]</Image>
+  <Image width="16" height="16" type="image/x-icon">/static/img/favicon.ico</Image>
-  <Url type="text/html" template="[searchURL]">
+  <Url type="text/html" template="SHOOGLE_URL">
-    <Param name="[key name]" value="{searchTerms}"/>
+    <Param name="q" value="{searchTerms}"/>
-    <!-- other Params if you need them… -->
-    <Param name="[other key name]" value="[parameter value]"/>
   </Url>
-  <Url type="application/x-suggestions+json" template="[suggestionURL]"/>
+  <Url type="application/x-suggestions+json" template="SHOOGLE_URL"/>
-  <moz:SearchForm>[https://example.com/search]</moz:SearchForm>
+  <moz:SearchForm>SHOOGLE_URL</moz:SearchForm>
 </OpenSearchDescription>
+

opensearch.py

@@ -0,0 +1,19 @@
+import sys
+
+template_path = './app/static/opensearch.template'
+opensearch_path = './app/static/opensearch.xml'
+replace_tag = 'SHOOGLE_URL'
+
+if len(sys.argv) != 2:
+    print('You must provide the url as an argument for this script.')
+    print('Example: python opensearch.py "https://my-app-1776.herokuapps.com"')
+    sys.exit(0)
+
+app_url = sys.argv[1]
+opensearch_template = open(template_path, 'r').read()
+
+with open(opensearch_path, 'w') as opensearch_xml:
+    opensearch_xml.write(opensearch_template.replace(replace_tag, app_url))
+    opensearch_xml.close()
+
+print('\nDone - you may now set Shoogle as your primary search engine')