Skip to content

Commit 30bf3a8

Browse files
author
Aaron Gonzales
committed
updated readme
1 parent 9f9e2ba commit 30bf3a8

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Features
1010
========
1111

1212
- Command-line utility is pipeable to other tools (e.g., ``jq``).
13-
- Delivers a stream of data to the user for low in-memory requirements
1413
- Automatically handles pagination of results with specifiable limits
14+
- Delivers a stream of data to the user for low in-memory requirements
1515
- Handles Enterprise and Premium authentication methods
1616
- Flexible usage within a python program
1717
- Compatible with our group's Tweet Parser for rapid extraction of relevant data fields from each tweet payload
@@ -42,15 +42,14 @@ Using the Comand Line Application
4242
=================================
4343

4444
We provide a utility, ``twitter_search.py``, in the ``tools`` directory that provides rapid access to tweets.
45-
Premium customers should use ``--bearer-token`` instead of ``--user-name`` and ``--password``.
45+
Premium customers should use ``--bearer-token``; enterprise customers should use ``--user-name`` and ``--password``.
4646

4747
**Stream json results to stdout without saving**
4848

4949
.. code:: bash
5050
5151
python twitter_search.py \
52-
--user-name <USERNAME> \
53-
--password <PW> \
52+
--bearer-token <BEARER_TOKEN> \
5453
--endpoint <MY_ENDPOINT> \
5554
--max-tweets 1000 \
5655
--filter-rule "beyonce has:geo" \
@@ -115,7 +114,8 @@ It can be far easier to specify your information in a configuration file. An exa
115114
116115
When using a config file in conjunction with the command-line utility, you need to specify your config file via the ``--config-file`` parameter. Additional command-line arguments will either be *added* to the config file args or **overwrite** the config file args if both are specified and present.
117116

118-
example::
117+
118+
Example::
119119

120120
python twitter_search_api.py \
121121
--config-file myapiconfig.config \
@@ -187,13 +187,13 @@ following cell for setup:
187187
188188
# set your environment variables here for premium access if you need to
189189
# os.environ["TWITTER_SEARCH_BEARER_TOKEN"] = ""
190-
190+
191191
premium_search_endpoint = "https://api.twitter.com/1.1/tweets/search/30day/dev.json"
192-
192+
193193
premium_search_args = {"bearer_token": os.environ["TWITTER_SEARCH_BEARER_TOKEN"],
194194
"endpoint": premium_search_endpoint,
195195
}
196-
196+
197197
print(premium_search_endpoint)
198198
199199

0 commit comments

Comments
 (0)