[BAHIR-30] Add basic documentation for Twitter connector
Project: http://git-wip-us.apache.org/repos/asf/bahir/repo Commit: http://git-wip-us.apache.org/repos/asf/bahir/commit/c78af705 Tree: http://git-wip-us.apache.org/repos/asf/bahir/tree/c78af705 Diff: http://git-wip-us.apache.org/repos/asf/bahir/diff/c78af705 Branch: refs/heads/master Commit: c78af705f5697ab11d93f933d033d96cc48403a0 Parents: 619936d Author: Luciano Resende <[email protected]> Authored: Mon Aug 1 19:20:20 2016 +0300 Committer: Luciano Resende <[email protected]> Committed: Wed Aug 3 22:11:43 2016 +0300 ---------------------------------------------------------------------- streaming-twitter/README.md | 58 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/bahir/blob/c78af705/streaming-twitter/README.md ---------------------------------------------------------------------- diff --git a/streaming-twitter/README.md b/streaming-twitter/README.md new file mode 100644 index 0000000..6c16438 --- /dev/null +++ b/streaming-twitter/README.md @@ -0,0 +1,58 @@ + +A library for reading social data from [twitter](http://twitter.com/) using Spark Streaming. + +## Linking + +Using SBT: + +``` +libraryDependencies += "org.apache.bahir" %% "spark-streaming-twitter" % "2.0.0" +``` + +Using Maven: + +```xml +<dependency> + <groupId>org.apache.bahir</groupId> + <artifactId>spark-streaming-twitter_2.11</artifactId> + <version>2.0.0</version> +</dependency> +``` + +This library can also be added to Spark jobs launched through `spark-shell` or `spark-submit` by using the `--packages` command line option. +For example, to include it when starting the spark shell: + +``` +$ bin/spark-shell --packages org.apache.bahir:spark-streaming_twitter_2.11:2.0.0 +``` + +Unlike using `--jars`, using `--packages` ensures that this library and its dependencies will be added to the classpath. +The `--packages` argument can also be used with `bin/spark-submit`. + +This library is cross-published for Scala 2.10 and Scala 2.11, so users should replace the proper Scala version (2.10 or 2.11) in the commands listed above. + + +## Examples + +`TwitterUtils` uses Twitter4j to get the public stream of tweets using [Twitter's Streaming API](https://dev.twitter.com/docs/streaming-apis). Authentication information +can be provided by any of the [methods](http://twitter4j.org/en/configuration.html) supported by Twitter4J library. You can import the `TwitterUtils` class and create a DStream with `TwitterUtils.createStream` as shown below. + +### Scala API + +```Scala +import org.apache.spark.streaming.twitter._ + +TwitterUtils.createStream(ssc, None) +``` + +### Java API + +```Java +import org.apache.spark.streaming.twitter.*; + +TwitterUtils.createStream(jssc); +``` + + +You can also either get the public stream, or get the filtered stream based on keywords. +See end-to-end examples at ([Twitter Examples](https://github.com/apache/bahir/tree/master/streaming-twitter/examples) \ No newline at end of file
