Merge pull request #10 from twitterdev/naming_results_params

updated command-line utility to work with naming changes

Author: Aaron Gonzales

README.rst

@@ -53,7 +53,7 @@ The ``--endpoint`` flag will specify the full URL of your connection, e.g.:
 
 You can find this url in your developer console.
 
-Note that the ``--max-results`` flag specifies an argument to the API call (results returned per CALL), not as a hard max to number of results returned from this program. use ``--max-tweets`` for that for now.
+Note that the ``--results-per-call`` flag specifies an argument to the API call ( ``maxResults``, results returned per CALL), not as a hard max to number of results returned from this program. use ``--max-results`` for that for now.
 
 
 
@@ -64,8 +64,8 @@ Note that the ``--max-results`` flag specifies an argument to the API call (resu
   python twitter_search.py \
     --bearer-token <BEARER_TOKEN> \
     --endpoint <MY_ENDPOINT> \
-    --max-tweets 1000 \
-    --max-results 100 \
+    --max-results 1000 \
+    --results-per-call 100 \
     --filter-rule "beyonce has:hashtags" \
     --print-stream
 
@@ -78,8 +78,8 @@ Note that the ``--max-results`` flag specifies an argument to the API call (resu
     --user-name <USERNAME> \
     --password <PW> \
     --endpoint <MY_ENDPOINT> \
-    --max-tweets 1000 \
-    --max-results 100 \
+    --max-results 1000 \
+    --results-per-call 100 \
     --filter-rule "beyonce has:hashtags" \
     --filename-prefix beyonce_geo \
     --print-stream
@@ -93,8 +93,8 @@ Note that the ``--max-results`` flag specifies an argument to the API call (resu
     --user-name <USERNAME> \
     --password <PW> \
     --endpoint <MY_ENDPOINT> \
-    --max-tweets 100 \
     --max-results 100 \
+    --results-per-call 100 \
     --filter-rule "beyonce has:hashtags" \
     --filename-prefix beyonce_geo \
     --no-print-stream
@@ -122,7 +122,7 @@ It can be far easier to specify your information in a configuration file. An exa
 
 
   [search_params]
-  max_tweets = 500
+  max_results = 500
 
   [output_params]
   output_file_prefix = beyonce

tools/twitter_search.py

@@ -71,11 +71,13 @@ def parse_cmd_args():
                                 default=None,
                                 help="PowerTrack filter rule (See: http://support.gnip.com/customer/portal/articles/901152-powertrack-operators)")
 
-    twitter_parser.add_argument("--max-results", dest="max_results",
+    twitter_parser.add_argument("--results-per-call", dest="results_per_call",
                                 default=100,
-                                help="Maximum results to return per api call (default 100; max 500)")
+                                help="Number of results to return per call "
+                                "(default 100; max 500) - corresponds to "
+                                "'maxResults' in the API")
 
-    twitter_parser.add_argument("--max-tweets", dest="max_tweets",
+    twitter_parser.add_argument("--max-results", dest="max_results",
                                 default=500,
                                 type=int,
                                 help="Maximum results to return for this "
@@ -86,8 +88,8 @@ def parse_cmd_args():
                                 dest="max_pages",
                                 type=int,
                                 default=None,
-                                help="Maximum number of pages to use "
-                                "for this session.")
+                                help="Maximum number of pages/api calls to "
+                                "use for this session.")
 
     twitter_parser.add_argument("--results-per-file", dest="results_per_file",
                                 default=0,

twittersearch/api_utils.py

@@ -185,7 +185,7 @@ def gen_params_from_config(config_dict):
              "bearer_token": config_dict.get("bearer_token"),
              "rule_payload": rule,
              "results_per_file": int(config_dict.get("results_per_file")),
-             "max_tweets": int(config_dict.get("max_tweets")),
+             "max_results": int(config_dict.get("max_results")),
              "max_pages": config_dict.get("max_pages", None)}
     return _dict