Skip to content
This repository has been archived by the owner on Aug 6, 2023. It is now read-only.

Commit

Permalink
Adding --follow (-F) and scripts/lookup-users.py docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
inactivist committed Mar 15, 2013
1 parent a086a44 commit b52e3f7
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Expand Up @@ -50,15 +50,15 @@ URL encoding.
## Examples ##
Stream (filter) statuses containing both *car* **and** *dog*:

python streamer.py "car dog"
$ python streamer.py "car dog"

Stream statuses containing either *boat* **or** *bike*:

python streamer.py "boat,bike"
$ python streamer.py "boat,bike"

Stream statuses containing (*water* **and** *drink*) *or* (*eat* **and** *lunch*):

python streamer.py "water drink" "eat lunch"
$ python streamer.py "water drink" "eat lunch"

## Output Format ##
The default output mode dumps the unprocessed stream's JSON string for each received
Expand All @@ -73,6 +73,21 @@ element as an independent JSON object rather than treat the stream as a JSON arr
The program will produce CSV output when using `--fields` (`-f`) field specifiers.
See [*Field Output Selectors*](#field-output-selectors), below.
## Experimental Features ##
### Following users ###
As of v0.0.6-dev, you can follow user ids by using the `--follow` (`-F`) option.
The `--follow` option accepts a list of comma-separated integer user id values.

I plan to add user `screen_name` lookup at some point, in the meantime,
you can use the helper script `scripts/lookup-users.py`:

$ python scripts/lookup-users.py twitter,tweepy
tweepy: 14452478
twitter: 783214

(Please keep in mind that per the Streaming API docs, following users does not
filter results to only those users, rather, it adds the selected users' streams
to the incoming stream results.)

### Location-based searching ###
As of v0.0.4, you can add location-based search criteria by specifying the `--locations`
option. The value is a comma-separated list of longitude, latitude pairs that
Expand Down

0 comments on commit b52e3f7

Please sign in to comment.