Skip to content

Commit

Permalink
Merge branch 't897-links'
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin Littman committed Oct 20, 2017
2 parents a131483 + 60e432e commit 7f40629
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 19 deletions.
17 changes: 9 additions & 8 deletions docs/collections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Twitter user timeline

Twitter user timeline collections collect the 3,200 most recent tweets from each of
a list of Twitter accounts using `Twitter's user_timeline API
<https://dev.twitter.com/rest/reference/get/statuses/user_timeline>`_.
<https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline.html>`_.

**Seeds** for Twitter user timelines are individual Twitter accounts.

Expand Down Expand Up @@ -66,13 +66,14 @@ Twitter search

Twitter searches collect tweets from the last 7-9 days that match search
queries, similar to a regular search done on Twitter, using
the `Twitter Search API <https://dev.twitter.com/rest/public/search>`_.
the `Twitter Search API <https://developer.twitter.com/en/docs/tweets/search/overview/basic-search>`_.
This is **not** a complete search of all tweets; results are limited
both by time and arbitrary relevance (determined by Twitter).

Search queries must follow standard search term formulation; permitted queries
are listed in the documentation for the `Twitter Search API
<https://dev.twitter.com/rest/public/search>`_, or you can construct a query
<https://developer.twitter.com/en/docs/tweets/search/overview/operator_descriptions>`_,
or you can construct a query
using the `Twitter Advanced Search query builder
<https://twitter.com/search-advanced>`_.

Expand All @@ -99,7 +100,7 @@ Twitter sample

Twitter samples are a random collection of approximately 0.5--1% of public
tweets, using the `Twitter sample stream
<https://dev.twitter.com/streaming/reference/get/statuses/sample>`_, useful for
<https://developer.twitter.com/en/docs/tweets/sample-realtime/overview/GET_statuse_sample>`_, useful for
capturing a sample of what people are talking about on Twitter.
The Twitter sample stream returns approximately 0.5-1% of public tweets,
which is approximately 3GB a day (compressed).
Expand All @@ -125,7 +126,7 @@ Twitter filter
Twitter Filter collections harvest a live selection of public tweets from
criteria matching keywords, locations, or users, based on the
`Twitter filter streaming API
<https://dev.twitter.com/streaming/reference/post/statuses/filter>`_. Because
<https://developer.twitter.com/en/docs/tweets/filter-realtime/overview/statuses-filter>`_. Because
tweets are collected live, tweets from the past are not included. (Use a
:ref:`Twitter search` collection to find tweets from the recent past.)

Expand All @@ -135,14 +136,14 @@ location.
**Track** collects tweets based on a keyword search. A space between words
is treated as 'AND' and a comma is treated as 'OR'. Note that exact phrase
matching is not supported. See the `track parameter documentation
<https://dev.twitter.com/streaming/overview/request-parameters#track>`_ for more
<https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters#track>`_ for more
information.

**Follow** collects tweets that are posted by or about a user (not including
mentions) from a comma separated list of user IDs (the numeric identifier for
a user account). Tweets collected will include those made by the user, retweeting
the user, or replying to the user. See the `follow parameter documentation
<https://dev.twitter.com/streaming/overview/request-parameters#follow>`_ for
<https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters#follow>`_ for
more information.

- Note: The Twitter website does not provide a way to look up the user ID for a user account. You can use `https://tweeterid.com <https://tweeterid.com/>`_ for this purpose.
Expand All @@ -151,7 +152,7 @@ more information.
**Location** collects tweets that were geolocated within specific parameters,
based on a bounding box made using the southwest and northeast corner
coordinates. See the `location parameter documentation
<https://dev.twitter.com/streaming/overview/request-parameters#location>`_ for
<https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters#location>`_ for
more information.

Twitter will return a limited number of tweets, so filters that return many
Expand Down
5 changes: 2 additions & 3 deletions docs/data_dictionary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,8 @@ Twitter Dictionary
------------------

For more info about source tweet data, see the `Twitter API documentation
<https://dev.twitter.com/docs>`_, including `Tweets
<https://dev.twitter.com/docs/platform-objects/tweets>`_ and `Entities
<https://dev.twitter.com/docs/platform-objects/entities>`_.
<https://developer.twitter.com/en/docs>`_, including `Tweet data dictionaries
<https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/intro-to-tweet-json.html>`_.

Documentation about older archived tweets is archived by the Wayback Machine for
the `Twitter API
Expand Down
2 changes: 1 addition & 1 deletion docs/messaging_spec.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Background information
requester may also want to monitor the status of a harvest. In the current
architecture, the SFM UI serves the role of requester.
* A stream harvest is a harvest that is intended to continue indefinitely until
terminated. A harvest of a `Twitter public stream <https://dev.twitter.com/streaming/public>`_
terminated. A harvest of a Twitter sample stream
is an example of a stream harvest. A stream harvest is different from a non-stream
harvest in that a requester must both start and optionally stop a stream harvest.
Following the naming conventions from Twitter, a harvest of a REST, non-streaming API
Expand Down
2 changes: 1 addition & 1 deletion docs/userguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ platforms' terms (`Twitter <https://twitter.com/rules>`_,
`Tumblr <https://www.tumblr.com/policy/en/terms-of-service>`_),
as you agreed to them when you created your social media account. Social Feed
Manager respects those platforms' terms as an application
(`Twitter <https://dev.twitter.com/overview/terms/policy>`_,
(`Twitter <https://developer.twitter.com/en/developer-terms/policy>`_,
`Flickr <https://www.flickr.com/services/developer>`_,
`Sina Weibo <http://open.weibo.com/wiki/%E9%A6%96%E9%A1%B5>`_,
`Tumblr <https://www.tumblr.com/docs/en/api_agreement>`_).
Expand Down
11 changes: 6 additions & 5 deletions sfm/ui/forms.py
Original file line number Diff line number Diff line change
Expand Up @@ -574,7 +574,7 @@ def clean_token(self):

class SeedTwitterSearchForm(BaseSeedForm):
query = forms.CharField(required=False, widget=forms.Textarea(attrs={'rows': 4}),
help_text='See <a href="https://dev.twitter.com/rest/public/search" target="_blank">' \
help_text='See <a href="https://developer.twitter.com/en/docs/tweets/search/overview/operator_descriptions" target="_blank">' \
'these instructions</a> for writing a query. ' \
'Example: firefly OR "lightning bug"')
geocode = forms.CharField(required=False,
Expand Down Expand Up @@ -647,18 +647,19 @@ def __init__(self, *args, **kwargs):
class SeedTwitterFilterForm(BaseSeedForm):
track = forms.CharField(required=False, widget=forms.Textarea(attrs={'rows': 4}),
help_text="""Separate keywords and phrases with commas. See Twitter <a
target="_blank" href="https://dev.twitter.com/streaming/overview/request-parameters#track">
target="_blank" href="https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters#track">
track</a> for more information.""")
follow = forms.CharField(required=False, widget=forms.Textarea(attrs={'rows': 4}),
help_text="""Use commas to separate user IDs (e.g. 1233718,6378678) of accounts whose
tweets, retweets, and replies will be collected. See Twitter <a
target="_blank"
href="https://dev.twitter.com/streaming/overview/request-parameters#follow"> follow</a>
documentation for a full list of what is returned.""")
href="https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters#follow"> follow</a>
documentation for a full list of what is returned. User <a target="_blank"
href="https://tweeterid.com/">TweeterID</a> to get the user ID for a screen name.""")
locations = forms.CharField(required=False, widget=forms.Textarea(attrs={'rows': 4}),
help_text="""Provide a longitude and latitude (e.g. -74,40,-73,41) of a geographic
bounding box. See Twitter <a target="blank"
href="https://dev.twitter.com/streaming/overview/request-parameters#locations">
href="https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters#locations">
locations</a> for more information.""")

def __init__(self, *args, **kwargs):
Expand Down
2 changes: 1 addition & 1 deletion sfm/ui/templates/ui/terms_snippet.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<p>Collecting and using data from social media platforms is subject to those platforms' terms (<a href="https://twitter.com/rules" target="_blank">Twitter</a>,
<a href="https://www.flickr.com/help/guidelines" target="_blank">Flickr</a>, <a href="http://www.weibo.com/signup/v5/protocol" target="_blank">Sina Weibo</a>, <a href="https://www.tumblr.com/policy/en/terms-of-service" target="_blank">Tumblr</a>),
as you agreed to them when you created your social media account. Social Feed Manager respects those platforms' terms as an
application (<a href="https://dev.twitter.com/overview/terms/policy" target="_blank">Twitter</a>, <a href="https://www.flickr.com/services/developer" target="_blank">Flickr</a>, <a href="http://open.weibo.com/wiki/%E9%A6%96%E9%A1%B5" target="_blank">Sina Weibo</a>, <a href="https://www.tumblr.com/docs/en/api_agreement" target="_blank">Tumblr</a>). </p>
application (<a href="https://developer.twitter.com/en/developer-terms/policy" target="_blank">Twitter</a>, <a href="https://www.flickr.com/services/developer" target="_blank">Flickr</a>, <a href="http://open.weibo.com/wiki/%E9%A6%96%E9%A1%B5" target="_blank">Sina Weibo</a>, <a href="https://www.tumblr.com/docs/en/api_agreement" target="_blank">Tumblr</a>). </p>

<p>Social Feed Manager provides data to you for your research and academic use. Social media platforms' terms of service <strong>generally do not allow
republishing of full datasets,</strong> and you should refer to their terms to understand what you may share.
Expand Down

0 comments on commit 7f40629

Please sign in to comment.