search_tweets.py environment detection fix (#26)

* added proper env shebang for environment detection when using search_tweets script

* updated docs to reflect bin installation of search_tweets.py

* bumped version

* updated base readme text

Author: Aaron Gonzales

README.rst

@@ -232,8 +232,10 @@ are used to control credential behavior from the command-line app.
 Using the Comand Line Application
 =================================
 
-The library includes an application, ``search_tweets.py``, in the
-``tools`` directory that provides rapid access to Tweets.
+The library includes an application, ``search_tweets.py``, that provides
+rapid access to Tweets. When you use ``pip`` to install this package,
+``search_tweets.py`` is installed globally. The file is located in the
+``tools/`` directory for those who want to run it locally.
 
 Note that the ``--results-per-call`` flag specifies an argument to the
 API ( ``maxResults``, results returned per CALL), not as a hard max to
@@ -247,7 +249,7 @@ environment variables.
 
 .. code:: bash
 
-    python search_tweets.py \
+    search_tweets.py \
       --max-results 1000 \
       --results-per-call 100 \
       --filter-rule "beyonce has:hashtags" \
@@ -257,7 +259,7 @@ environment variables.
 
 .. code:: bash
 
-    python search_tweets.py \
+    search_tweets.py \
       --max-results 1000 \
       --results-per-call 100 \
       --filter-rule "beyonce has:hashtags" \
@@ -268,7 +270,7 @@ environment variables.
 
 .. code:: bash
 
-    python search_tweets.py \
+    search_tweets.py \
       --max-results 100 \
       --results-per-call 100 \
       --filter-rule "beyonce has:hashtags" \
@@ -323,7 +325,7 @@ Example:
 
 ::
 
-    python search_tweets.py \
+    search_tweets.py \
       --config-file myapiconfig.config \
       --no-print-stream
 

examples/base_readme.rst

@@ -48,7 +48,10 @@ Or you can install the development version locally via
 Using the Comand Line Application
 =================================
 
-The library includes an application, ``search_tweets.py``, in the ``tools`` directory that provides rapid access to Tweets.
+The library includes an application, ``search_tweets.py``, that provides rapid
+access to Tweets. When you use ``pip`` to install this package,
+``search_tweets.py`` is installed globally. The file is located in the
+``tools/`` directory for those who want to run it locally.
 
 Note that the ``--results-per-call`` flag specifies an argument to the API
 ( ``maxResults``, results returned per CALL), not as a hard max to number of
@@ -62,7 +65,7 @@ your credentials are set up correctly in the default location
 
 .. code:: bash
 
-  python search_tweets.py \
+  search_tweets.py \
     --max-results 1000 \
     --results-per-call 100 \
     --filter-rule "beyonce has:hashtags" \
@@ -73,7 +76,7 @@ your credentials are set up correctly in the default location
 
 .. code:: bash
 
-  python search_tweets.py \
+  search_tweets.py \
     --max-results 1000 \
     --results-per-call 100 \
     --filter-rule "beyonce has:hashtags" \
@@ -85,7 +88,7 @@ your credentials are set up correctly in the default location
 
 .. code:: bash
 
-  python search_tweets.py \
+  search_tweets.py \
     --max-results 100 \
     --results-per-call 100 \
     --filter-rule "beyonce has:hashtags" \
@@ -140,7 +143,7 @@ command-line arguments will either be *added* to the config file args or
 
 Example::
 
-  python search_tweets.py \
+  search_tweets.py \
     --config-file myapiconfig.config \
     --no-print-stream
 

setup.py

@@ -7,7 +7,7 @@
       long_description=open('README.rst', 'r', encoding="utf-8").read(),
       author_email='agonzales@twitter.com',
       license='MIT',
-      version='1.3.1',
+      version='1.3.2',
       python_requires='>=3.3',
       install_requires=["requests", "tweet_parser", "pyyaml"],
       packages=find_packages(),

tools/search_tweets.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 # Copyright 2017 Twitter, Inc.
 # Licensed under the Apache License, Version 2.0
 # http://www.apache.org/licenses/LICENSE-2.0