twitter-conduit: An Conduit based Twitter API library for Haskell

Travis Hackage-Deps

About

This is an conduit based Twitter API library for Haskell, including Streaming API supports.

Documentation is available in hackage.

Usage

$ cabal update
$ cabal install twitter-conduit

Quick Start

For a runnable example, see sample/simple.hs. You can find other various examples in sample directory.

Run Samples

Build

If you would like to use cabal sandbox, prepare sandbox as below:

~~~~ $ cabal sandbox init

~~~~

and then,

~~~~ $ cabal install --only-dependencies -fbuild-samples $ cabal configure -fbuild-samples $ cabal build

~~~~

Run

First, you must obtain consumer key and secret from Twitter Application Management page, and you have to set those values to environment variables as shown below:

~~~~ $ export OAUTHCONSUMERKEY="YOUR APPLICATION CONSUMER KEY" $ export OAUTHCONSUMERSECRET="YOUR APPLICATION CONSUMER SECRET"

~~~~

Before you run examples, you must prepare OAuth access token and secret. You can obtain access token and secret by using either PIN or web callback.

If you would like to use the PIN method, you run simply as below, and follow instructions:

~~~~ $ cabal run oauth_pin

~~~~

On the other hand, If you would like to use the callback method, do as follows:

~~~~ $ cabal run oauth_callback

~~~~

and open http://localhost:3000/signIn in your browser.

In both cases, you can obtain OAUTHACCESSSTOKEN and OAUTHACCESSSECRET variables, then you should set those values to environment variables as shown below:

~~~~ $ export OAUTHACCESSTOKEN="YOUR ACCESS TOKEN" $ export OAUTHACCESSSECRET="YOUR ACCESS SECRET"

~~~~

Finally, you can access Twitter UserStream as follows:

~~~~ $ cabal run userstream

~~~~

Examples

TODO

Authors and Credits

twitter-conduit initially was written by Takahiro Himura. We would like to thank everyone who supported and contributed to the development of this library.

Changes

0.2.2

  • Upgrade http-conduit and http-client dependencies to: http-conduit >= 2.1.8 && http-client >= 0.4.30 #51
  • Added include_email parameter to AccountVerifyCredentials #49
  • Added extAltText parameter to showId #50

0.2.1

  • Added fullText parameter to direct message calls #47
  • Replaced SearchStatus with Status type #46
  • Added accountUpdateProfile #45
  • Added listsMembersCreateAll and listsMembersDestroyAll
  • Parameter lenses in Web.Twitter.Conduit re-exported from Web.Twitter.Conduit.Parameters are deprecated

0.2.0

  • Changed the signature of functions defined in Web.Twitter.Conduit.Base, because Manager of http-conduit 2.0 and later does not need MonadResource. #43
  • Removed TwitterBaseM
  • Removed TW monad
  • Re-exported OAuth (..) and Credential (..) from authenticate-oauth
  • Re-exported def from data-default
  • Re-exported Manager, newManager and tlsManagerSettings from http-conduit

0.1.3

  • Make TWToken and TWInfo an instance of Read and Typeable #42

0.1.2

  • Streaming API: Support multiple filters #41
  • Include parameters in body for POST requests #40

0.1.1.1

  • Fix warnings on GHC 7.10
  • Fix doctest when twitter-feed package exists

0.1.1

  • Add sourceWithSearchResult and sourceWithSearchResult'
comments powered byDisqus