mirror of https://github.com/zulip/zulip.git
Migrate integrations/twitter.html to markdown.
This commit is contained in:
Aditya Bansal
Tim Abbott
parent
642deef72f
commit
12c6ffa593
|
|
@ -1,92 +0,0 @@
|
|||
<p>
|
||||
See Twitter search results in Zulip! This is great for seeing and
|
||||
discussing who is talking about you, friends, competitors, or important
|
||||
topics in real time.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
First, create the stream you'd like to use for tweets, and subscribe
|
||||
all interested parties to this stream. We recommend the
|
||||
name <code>twitter</code>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Next, download and install our
|
||||
<a href="/api">Python bindings and example scripts</a>.
|
||||
This bot should be set up on a trusted machine,
|
||||
because your API key is visible to local users through the command line or
|
||||
config file.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Next, install <b>version 1.0 or later</b> of
|
||||
the <code>twitter-python</code> library. If your operating system
|
||||
distribution doesn't package a new enough version, you can install the
|
||||
library from source from
|
||||
<a href="https://github.com/bear/python-twitter">the GitHub repository</a>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Next, set up Twitter authentication. This bot uses OAuth to
|
||||
authenticate with Twitter, and in order to obtain a consumer key & secret,
|
||||
you must register a new application under your Twitter account:
|
||||
</p>
|
||||
|
||||
<ol>
|
||||
<li>
|
||||
Log in to <a href="http://dev.twitter.com">http://dev.twitter.com</a>.
|
||||
</li>
|
||||
<li>
|
||||
In the menu under your username,
|
||||
click <a href="https://dev.twitter.com/apps">My Applications</a>. From
|
||||
this page, create a new application.
|
||||
</li>
|
||||
<li>
|
||||
Click on the application you created and click "create my access
|
||||
token". Fill in the requested values.
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
<p>To configure and deploy this bot:</p>
|
||||
|
||||
<ol>
|
||||
<li>
|
||||
Create a <code>~/.zulip_twitterrc</code> with the following
|
||||
contents:
|
||||
|
||||
<pre>[twitter]
|
||||
consumer_key =
|
||||
consumer_secret =
|
||||
access_token_key =
|
||||
access_token_secret =</pre>
|
||||
</li>
|
||||
<li>
|
||||
Test the script by running it manually:
|
||||
|
||||
<pre>/usr/local/share/zulip/integrations/twitter/twitter-search-bot --search="@nprnews,quantum physics" --site={{ external_api_uri_subdomain }}</pre>
|
||||
|
||||
Note: <code>twitter-search-bot</code> may install to a different
|
||||
location on your operating system distribution.
|
||||
</li>
|
||||
<li>
|
||||
Configure a crontab entry for this script. A sample crontab entry that
|
||||
will process tweets every minute is:
|
||||
|
||||
<pre>* * * * * /usr/local/share/zulip/integrations/twitter/twitter-search-bot --search="@nprnews,quantum physics" --site={{ external_api_uri_subdomain }}</pre>
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
<p>
|
||||
<b>Congratulations! You're done!</b><br/> When someone tweets a
|
||||
message containing one of your search terms, you'll get a Zulip on your
|
||||
specified stream, with the search term as the topic.
|
||||
</p>
|
||||
|
||||
<img class="screenshot" src="/static/images/integrations/twitter/001.png"/>
|
||||
|
||||
<p>
|
||||
Note that the twitter search bot integration
|
||||
<b>just sends links to tweets</b>; the pretty inline previews of tweets are
|
||||
generated by the Twitter card rendering integration configured
|
||||
in <code>/etc/zulip/settings.py</code> on the Zulip server.
|
||||
</p>
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
See Twitter search results in Zulip! This is great for seeing and
|
||||
discussing who is talking about you, friends, competitors, or
|
||||
important topics in real time.
|
||||
|
||||
First, create the stream you’d like to use for tweets, and subscribe
|
||||
all interested parties to this stream. We recommend the name
|
||||
`twitter`.
|
||||
|
||||
{! download-python-bindings.md !} This bot should be set up on a
|
||||
trusted machine, because your API key is visible to local users
|
||||
through the command line or config file.
|
||||
|
||||
Next, install **version 1.0 or later** of the `twitter-python`
|
||||
library. If your operating system distribution doesn’t package a new
|
||||
enough version, you can install the library from source from
|
||||
[the GitHub repository](https://github.com/bear/python-twitter).
|
||||
|
||||
Next, set up Twitter authentication. This bot uses OAuth to
|
||||
authenticate with Twitter, and in order to obtain a consumer key &
|
||||
secret, you must register a new application under your Twitter
|
||||
account:
|
||||
|
||||
1. Log in to <http://dev.twitter.com>.
|
||||
2. In the menu under your username, click
|
||||
[My Applications](https://dev.twitter.com/apps). From this page,
|
||||
create a new application.
|
||||
3. Click on the application you created and click “create my access
|
||||
token”. Fill in the requested values.
|
||||
|
||||
To configure and deploy this bot:
|
||||
|
||||
1. Create a `~/.zulip_twitterrc` with the following contents:
|
||||
|
||||
[twitter]
|
||||
consumer_key =
|
||||
consumer_secret =
|
||||
access_token_key =
|
||||
access_token_secret =
|
||||
|
||||
2. Test the script by running it manually:
|
||||
|
||||
/usr/local/share/zulip/integrations/twitter/twitter-search-bot --search="@nprnews,quantum
|
||||
physics" --site={{ external_api_uri_subdomain }}
|
||||
|
||||
Note: `twitter-search-bot` may install to a different location on
|
||||
your operating system distribution.
|
||||
|
||||
3. Configure a crontab entry for this script. A sample crontab entry
|
||||
that will process tweets every minute is:
|
||||
|
||||
* * * * * /usr/local/share/zulip/integrations/twitter/twitter-search-bot
|
||||
--search="@nprnews,quantum physics" --site={{ external_api_uri_subdomain }}
|
||||
|
||||
When someone tweets a message containing one of your search terms,
|
||||
you’ll get a Zulip on your specified stream, with the search term as
|
||||
the topic.
|
||||
|
||||
{! congrats.md !}
|
||||
|
||||
|
||||
|
||||
Note that the twitter search bot integration **just sends links to
|
||||
tweets**; the pretty inline previews of tweets are generated by the
|
||||
Twitter card rendering integration configured in
|
||||
`/etc/zulip/settings.py` on the Zulip server.
|
||||
|
|
@ -268,7 +268,7 @@ INTEGRATIONS = {
|
|||
display_name='Trello',
|
||||
doc='zerver/integrations/trello-plugin.html'
|
||||
),
|
||||
'twitter': Integration('twitter', 'twitter', doc='zerver/integrations/twitter.html'),
|
||||
'twitter': Integration('twitter', 'twitter', doc='zerver/integrations/twitter.md'),
|
||||
|
||||
} # type: Dict[str, Integration]
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue