Skip to main content

tweetstream - Simple twitter streaming API

Introduction

tweetstream provides a class, TweetStream, that can be used to get tweets from Twitter’s streaming API. An instance of the class can be used as an iterator. In addition to fetching tweets, the object keeps track of the number of tweets collected and the rate at which tweets are received.

Subclasses are available for accessing the “track” and “follow” streams as well.

There’s also a ReconnectingTweetStream class that handles automatic reconnecting.

Twitter’s documentation about the streaming API can be found here: http://apiwiki.twitter.com/Streaming-API-Documentation .

Note that the API is blocking. If for some reason data is not immediatly available, calls will block until enough data is available to yield a tweet.

Examples

Printing all incomming tweets:

>>> stream = tweetstream.TweetStream("username", "password")
>>> for tweet in stream:
...     print tweet

The stream object can also be used as a context, as in this example that prints the author for each tweet as well as the tweet count and rate:

>>> with tweetstream.TweetStream("username", "password") as stream
...     for tweet in stream:
...         print "Got tweet from %-16s\t( tweet %d, rate %.1f tweets/sec)" % (
...                 tweet["user"]["screen_name"], stream.count, stream.rate )

Stream objects can raise ConnectionError or AuthenticationError exceptions:

>>> try:
...     with tweetstream.TweetStream("username", "password") as stream
...         for tweet in stream:
...             print "Got tweet from %-16s\t( tweet %d, rate %.1f tweets/sec)" % (
...                     tweet["user"]["screen_name"], stream.count, stream.rate )
... except tweetstream.ConnectionError, e:
...     print "Disconnected from twitter. Reason:", e.reason

To get tweets that relate to specific terms, use the TrackStream:

>>> words = ["opera", "firefox", "safari"]
>>> with tweetstream.TrackStream("username", "password", words) as stream
...     for tweet in stream:
...         print "Got interesting tweet:", tweet

To get only tweets from a set of users, use the FollowStream. The following would get tweets for user 1, 42 and 8675309

>>> users = [1, 42, 8675309]
>>> with tweetstream.TweetStream("username", "password", users) as stream
...     for tweet in stream:
...         print "Got  tweet from:", tweet["user"]["screen_name"]

Simple tweet fetcher that sends tweets to an AMQP message server using carrot:

>>> from carrot.messaging import Publisher
>>> from carrot.connection import AMQPConnection
>>> from tweetstream import TweetStream
>>> amqpconn = AMQPConnection(hostname="localhost", port=5672,
...                           userid="test", password="test",
...                           vhost="test")
>>> publisher = Publisher(connection=amqpconn,
...                       exchange="tweets", routing_key="stream")
>>> with TweetStream("username", "password") as stream:
...    for tweet in stream:
...        publisher.send(tweet)
>>> publisher.close()

Changelog

See the CHANGELOG file

Contact

The author is Rune Halvorsen <runefh@gmail.com>. The project resides at http://bitbucket.org/runeh/tweetstream . If you find bugs, or have feature requests, please report them in the project site issue tracker. Patches are also very welcome.

License

This software is licensed under the New BSD License. See the LICENCE file in the top distribution directory for the full license text.

Metadata

Release files for tweetstream 0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tweetstream 0.3
File Size Uploaded Provenance Actions
tweetstream-0.3.tar.gz 5.3 kB Without provenance Details for tweetstream-0.3.tar.gz

Release files / tweetstream-0.3.tar.gz

Download URL tweetstream-0.3.tar.gz
Size 5.3 kB
Tags Source
SHA-256 checksum
How to use checksums
374b08b30caa6aaf39bb85fe9a25d81ad2a6347132f5cd939884f51fdfd27eb3
BLAKE2b-256 checksum
How to use checksums
73943c4340fa2337165ba4b704374db37d86a05189cfe94aa8bf5c994aa27c76
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for tweetstream 0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page