bots: Move contrib_bots to api/bots*.

This will make it convenient to include these bots in Zulip API
releases on pypi.

Fix #5009.

.gitignore

@@ -31,4 +31,4 @@ var/*
 .vscode/
 tools/conf.ini
 tools/custom_provision
-contrib_bots/bots/john/assets/var/database.db
+api/bots/john/assets/var/database.db

api/bots/commute/commute.py

@@ -80,7 +80,7 @@ class CommuteHandler(object):
     # adds API Authentication Key to url request
     def get_api_key(self):
         # commute.config must be moved from
-        # ~/zulip/contrib_bots/bots/commute/commute.config into
+        # ~/zulip/api/bots/commute/commute.config into
         # ~/commute.config for program to work
         # see readme.md for more information
         with open(CONFIG_PATH) as settings:

api/bots/commute/readme.md

@@ -17,7 +17,7 @@ the user home directory and add an API key.
 Move
 
 ```
-~/zulip/contrib_bots/bots/commute/commute.config
+~/zulip/api/bots/commute/commute.config
 ```
 
 into

api/bots/converter/test_converter.py

@@ -7,6 +7,7 @@ import os
 import sys
 
 our_dir = os.path.dirname(os.path.abspath(__file__))
+sys.path.insert(0, os.path.normpath(os.path.join(our_dir)))
 # For dev setups, we can find the API in the repo itself.
 if os.path.exists(os.path.join(our_dir, '..')):
     sys.path.insert(0, '..')

api/bots/define/test_define.py

@@ -7,6 +7,7 @@ import os
 import sys
 
 our_dir = os.path.dirname(os.path.abspath(__file__))
+sys.path.insert(0, os.path.normpath(os.path.join(our_dir)))
 # For dev setups, we can find the API in the repo itself.
 if os.path.exists(os.path.join(our_dir, '..')):
     sys.path.insert(0, '..')

api/bots/encrypt/test_encrypt.py

@@ -7,6 +7,7 @@ import os
 import sys
 
 our_dir = os.path.dirname(os.path.abspath(__file__))
+sys.path.insert(0, os.path.normpath(os.path.join(our_dir)))
 # For dev setups, we can find the API in the repo itself.
 if os.path.exists(os.path.join(our_dir, '..')):
     sys.path.insert(0, '..')

api/bots/foursquare/foursquare.py

@@ -9,11 +9,11 @@ from six.moves import configparser as cp
 from six.moves import range
 
 home = expanduser('~')
-CONFIG_PATH = home + '/zulip/contrib_bots/bots/foursquare/foursquare.config'
+CONFIG_PATH = home + '/zulip/api/bots/foursquare/foursquare.config'
 
 def get_api_key():
     # foursquare.config must have been moved from
-    # ~/zulip/contrib_bots/bots/foursquare/foursquare.config into
+    # ~/zulip/api/bots/foursquare/foursquare.config into
     # ~/foursquare.config for program to work
     # see readme.md for more information
     with open(CONFIG_PATH) as settings:

api/bots/git_hub_comment/readme.md

@@ -26,8 +26,8 @@ github_token = <oauth_token>   (The personal access token for the GitHub bot)
 Here is an example of running the `git_hub_comment` bot from
 inside a Zulip repo:
 
-    `cd ~/zulip/contrib_bots`
-    `./run.py bots/git_hub_comment/git_hub_comment.py --config-file ~/.zuliprc-prod`
+    `cd ~/zulip/api`
+    `bots_api/run.py bots/git_hub_comment/git_hub_comment.py --config-file ~/.zuliprc-prod`
 
 Once the bot code starts running, you will see a
 message explaining how to use the bot, as well as

api/bots/helloworld/test_helloworld.py

@@ -8,6 +8,7 @@ import sys
 from six.moves import zip
 
 our_dir = os.path.dirname(os.path.abspath(__file__))
+sys.path.insert(0, os.path.normpath(os.path.join(our_dir)))
 # For dev setups, we can find the API in the repo itself.
 if os.path.exists(os.path.join(our_dir, '..')):
     sys.path.insert(0, '..')

api/bots/help/test_help.py

@@ -8,6 +8,7 @@ import sys
 from six.moves import zip
 
 our_dir = os.path.dirname(os.path.abspath(__file__))
+sys.path.insert(0, os.path.normpath(os.path.join(our_dir)))
 # For dev setups, we can find the API in the repo itself.
 if os.path.exists(os.path.join(our_dir, '..')):
     sys.path.insert(0, '..')

api/bots/john/john.py

@@ -11,14 +11,14 @@ except ImportError:
     raise ImportError("""It looks like you are missing chatterbot.
                       Please: pip install chatterbot""")
 
-CONTRIB_BOTS_DIR = os.path.dirname(os.path.abspath(__file__))
-os.chdir(os.path.dirname(CONTRIB_BOTS_DIR))
-sys.path.insert(0, os.path.dirname(CONTRIB_BOTS_DIR))
+BOTS_DIR = os.path.dirname(os.path.abspath(__file__))
+os.chdir(os.path.dirname(BOTS_DIR))
+sys.path.insert(0, os.path.dirname(BOTS_DIR))
 
-JOKES_PATH = os.path.join(CONTRIB_BOTS_DIR, 'assets/var/jokes.json')
-DATABASE_PATH = os.path.join(CONTRIB_BOTS_DIR, 'assets/var/database.db')
-DIRECTORY_PATH = os.path.join(CONTRIB_BOTS_DIR, 'assets')
-VAR_PATH = os.path.join(CONTRIB_BOTS_DIR, 'assets/var')
+JOKES_PATH = os.path.join(BOTS_DIR, 'assets/var/jokes.json')
+DATABASE_PATH = os.path.join(BOTS_DIR, 'assets/var/database.db')
+DIRECTORY_PATH = os.path.join(BOTS_DIR, 'assets')
+VAR_PATH = os.path.join(BOTS_DIR, 'assets/var')
 
 if not os.path.exists(DIRECTORY_PATH):
     os.makedirs(DIRECTORY_PATH)

api/bots/readme.md

@@ -29,8 +29,8 @@ to messages in any of the following settings:
 Here is an example of running the "follow-up" bot from
 inside a Zulip repo (and in your remote instance):
 
-    cd ~/zulip/contrib_bots
-    ./run.py bots/followup/followup.py --config-file ~/.zuliprc-prod
+    cd ~/zulip/api
+    bots_api/run.py bots/followup/followup.py --config-file ~/.zuliprc-prod
 
 Once the bot code starts running, you will see a
 message explaining how to use the bot, as well as

api/bots/thesaurus/test_thesaurus.py

@@ -7,6 +7,7 @@ import os
 import sys
 
 our_dir = os.path.dirname(os.path.abspath(__file__))
+sys.path.insert(0, os.path.normpath(os.path.join(our_dir)))
 # For dev setups, we can find the API in the repo itself.
 if os.path.exists(os.path.join(our_dir, '..')):
     sys.path.insert(0, '..')

api/bots/thesaurus/thesaurus.py

@@ -1,4 +1,4 @@
-# See zulip/contrib_bots/bots/readme.md for instructions on running this code.
+# See zulip/api/bots/readme.md for instructions on running this code.
 from __future__ import print_function
 import sys
 import logging

api/bots/virtual_fs/test_virtual_fs.py

@@ -7,6 +7,7 @@ import os
 import sys
 
 our_dir = os.path.dirname(os.path.abspath(__file__))
+sys.path.insert(0, os.path.normpath(os.path.join(our_dir)))
 # For dev setups, we can find the API in the repo itself.
 if os.path.exists(os.path.join(our_dir, '..')):
     sys.path.insert(0, '..')

api/bots/wikipedia/test_wikipedia.py

@@ -7,6 +7,7 @@ import os
 import sys
 
 our_dir = os.path.dirname(os.path.abspath(__file__))
+sys.path.insert(0, os.path.normpath(os.path.join(our_dir)))
 # For dev setups, we can find the API in the repo itself.
 if os.path.exists(os.path.join(our_dir, '..')):
     sys.path.insert(0, '..')

api/bots/xkcd/test_xkcd.py

@@ -8,6 +8,7 @@ import os
 import sys
 
 our_dir = os.path.dirname(os.path.abspath(__file__))
+sys.path.insert(0, os.path.normpath(os.path.join(our_dir)))
 # For dev setups, we can find the API in the repo itself.
 if os.path.exists(os.path.join(our_dir, '..')):
     sys.path.insert(0, '..')