Skip to content

Commit 736e7fc

Browse files
author
Aaron Gonzales
committed
update docs
1 parent 9f83e0d commit 736e7fc

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.rst

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,17 @@ Using the Comand Line Application
4444
We provide a utility, ``twitter_search.py``, in the ``tools`` directory that provides rapid access to tweets.
4545
Premium customers should use ``--bearer-token``; enterprise customers should use ``--user-name`` and ``--password``.
4646

47+
The ``--endpoint`` flag will specify the full URL of your connection, e.g.:
48+
49+
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.
50+
51+
.. code:: bash
52+
53+
https://api.twitter.com/1.1/tweets/search/30day/dev.json
54+
55+
You can find this url in your developer console.
56+
57+
4758
**Stream json results to stdout without saving**
4859

4960
.. code:: bash
@@ -52,7 +63,8 @@ Premium customers should use ``--bearer-token``; enterprise customers should use
5263
--bearer-token <BEARER_TOKEN> \
5364
--endpoint <MY_ENDPOINT> \
5465
--max-tweets 1000 \
55-
--filter-rule "beyonce has:geo" \
66+
--max-results 100 \
67+
--filter-rule "beyonce has:hashtags" \
5668
--print-stream
5769
5870
@@ -65,7 +77,8 @@ Premium customers should use ``--bearer-token``; enterprise customers should use
6577
--password <PW> \
6678
--endpoint <MY_ENDPOINT> \
6779
--max-tweets 1000 \
68-
--filter-rule "beyonce has:geo" \
80+
--max-results 100 \
81+
--filter-rule "beyonce has:hashtags" \
6982
--filename-prefix beyonce_geo \
7083
--print-stream
7184
@@ -79,7 +92,8 @@ Premium customers should use ``--bearer-token``; enterprise customers should use
7992
--password <PW> \
8093
--endpoint <MY_ENDPOINT> \
8194
--max-tweets 100 \
82-
--filter-rule "beyonce has:geo" \
95+
--max-results 100 \
96+
--filter-rule "beyonce has:hashtags" \
8397
--filename-prefix beyonce_geo \
8498
--no-print-stream
8599
@@ -101,8 +115,8 @@ It can be far easier to specify your information in a configuration file. An exa
101115
[gnip_search_rules]
102116
from_date = 2017-06-01
103117
to_date = 2017-09-01
104-
max_results = 500
105-
pt_rule = beyonce has:geo
118+
max_results = 100
119+
pt_rule = beyonce has:hashtags
106120
107121
108122
[search_params]

0 commit comments

Comments
 (0)