Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Python client to interface with DataSift
Python Shell

This branch is even with gh-pages

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
_modules
_sources
_static
old
.nojekyll
datasift.html
genindex.html
gettingstarted.html
index.html
modules.html
objects.inv
py-modindex.html
readme.html
search.html
searchindex.js
whatsnew.html

readme.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>DataSift Python Client Library &mdash; datasift 2.0.11 documentation</title>
    
    <link rel="stylesheet" href="_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '2.0.11',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="datasift 2.0.11 documentation" href="index.html" />
    <link rel="next" title="Getting Started" href="gettingstarted.html" />
    <link rel="prev" title="Welcome to the datasift Python module" href="index.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="gettingstarted.html" title="Getting Started"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Welcome to the datasift Python module"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">datasift 2.0.11 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="datasift-python-client-library">
<h1>DataSift Python Client Library<a class="headerlink" href="#datasift-python-client-library" title="Permalink to this headline">¶</a></h1>
<a class="reference external image-reference" href="https://travis-ci.org/datasift/datasift-python"><img alt="https://travis-ci.org/datasift/datasift-python.png" src="https://travis-ci.org/datasift/datasift-python.png" /></a>
<a class="reference external image-reference" href="https://pypi.python.org/pypi/datasift"><img alt="https://pypip.in/v/datasift/badge.png" src="https://pypip.in/v/datasift/badge.png" /></a>
<p>This is the official Python library for accessing <a class="reference external" href="http://datasift.com/">DataSift</a>.</p>
<p>We have recently performed a major update to this library. The previous version is available <a class="reference external" href="https://pypi.python.org/pypi/datasift/0.5.7">here</a>. That version will be supported until 4th September 2014.</p>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p>Install with <tt class="docutils literal"><span class="pre">pip</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre>pip install datasift
</pre></div>
</div>
<p>Install from source:</p>
<div class="highlight-python"><div class="highlight"><pre>git clone https://github.com/datasift/datasift-python.git
cd datasift-python
python setup.py install
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>Full documentation is available at <a class="reference external" href="http://datasift.github.io/datasift-python">http://datasift.github.io/datasift-python</a></p>
</div>
<div class="section" id="supported-operating-environment">
<h2>Supported Operating Environment<a class="headerlink" href="#supported-operating-environment" title="Permalink to this headline">¶</a></h2>
<p>This version of the client library has been tested, and is known to work against the following language versions and Operating Systems:</p>
<div class="section" id="language-versions">
<h3>Language versions<a class="headerlink" href="#language-versions" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Python 2.6</li>
<li>Python 2.7</li>
<li>Python 3.3</li>
<li>Python 3.4</li>
<li>pypy 2.7</li>
</ul>
</div>
<div class="section" id="operating-systems">
<h3>Operating Systems<a class="headerlink" href="#operating-systems" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Linux</li>
<li>BSD</li>
<li>OS X</li>
<li>Windows 7/8</li>
</ul>
</div>
</div>
<div class="section" id="style-guide">
<h2>Style Guide<a class="headerlink" href="#style-guide" title="Permalink to this headline">¶</a></h2>
<p>This code should conform to pep8, with the exception of E501, the 79 character line limit.</p>
<p>It can be style checked with the <tt class="docutils literal"><span class="pre">pep8</span></tt> module by running <tt class="docutils literal"><span class="pre">pep8</span> <span class="pre">--show-source</span> <span class="pre">--ignore=E501</span> <span class="pre">datasift/*.py</span></tt></p>
</div>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<p>Supports Python 2.6, 2.7 and 3.3, as well as pypy.
Uses <tt class="docutils literal"><span class="pre">requests</span></tt>, <tt class="docutils literal"><span class="pre">autobahn</span></tt>, <tt class="docutils literal"><span class="pre">six</span></tt>, <tt class="docutils literal"><span class="pre">twisted</span></tt>, <tt class="docutils literal"><span class="pre">pyopenssl</span></tt> and <tt class="docutils literal"><span class="pre">dateutil</span></tt>.</p>
<p>On non-Windows systems, the <tt class="docutils literal"><span class="pre">twisted</span></tt> and <tt class="docutils literal"><span class="pre">pyopenssl</span></tt> packages require the Python and OpenSSL development headers before they can be installed. These are usually provided by distribution package managers in a separate package to the main packages.</p>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
<p>All code contained in this repository is Copyright 2012-Present MediaSift Ltd.</p>
<p>This code is released under the BSD license. Please see the LICENSE file for
more details.</p>
</div>
<div class="section" id="changelog">
<h2>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first">v.2.0.11 Added support for pause and resume in historics (2014-08-27)</p>
</li>
<li><p class="first">v.2.0.10 Bumped to release stable version (2014-08-27)</p>
</li>
<li><p class="first">v.2.0.9 Bumped to release Dynamic Lists and new Managed Sources endpoints (2014-08-27)</p>
</li>
<li><p class="first">v.2.0.8 Bumped to release stable version (2014-06-04)</p>
</li>
<li><p class="first">v.2.0.7 Small bugfix for livestreaming (2014-05-09)</p>
</li>
<li><p class="first">v.2.0.6 Added windows support for livestreaming (2014-05-09)</p>
</li>
<li><p class="first">v.2.0.5 Added support for all 3 outputs in pull (2014-04-29)</p>
</li>
<li><p class="first">v.2.0.4 Upgraded the output mapper date logic to be more robust (2014-03-18)</p>
</li>
<li><p class="first">v.2.0.3 Fixed secure websockets on OpenSSL &gt;1.0 (2014-02-20)</p>
</li>
<li><p class="first">v.2.0.2 Improved reconnection logic for livestreaming (2014-02-20)</p>
</li>
<li><p class="first">v.2.0.1 Fixed disconnect problems in livestreaming on slow streams (2014-02-19)</p>
</li>
<li><p class="first">v.2.0.0 Ground up rewrite. (2014-02-14)</p>
</li>
<li><p class="first">v.0.5.7 Fixed issues with buffers on reconnections (2013-06-28)</p>
</li>
<li><p class="first">v.0.5.6 Fixed broken tests, multistreaming, reconnection timeout (2013-05-03)</p>
</li>
<li><p class="first">v.0.5.5 Introduced automatic reconnection after 65 seconds of no data or ticks. Solves &#8216;silent disconnect&#8217; issue (2013-03-06)</p>
</li>
<li><p class="first">v.0.5.4 Removed checks for existance of deprecated &#8216;volume_info&#8217; field in historics/prepare response (2013-01-18)</p>
</li>
<li><p class="first">v.0.5.3 Added missing Historic sample size into historic/prepare requests (2012-12-03)</p>
</li>
<li><p class="first">v.0.5.2 Patch for the missing availability info after Historic/prepare [woozyking](<a class="reference external" href="https://github.com/woozyking">https://github.com/woozyking</a>) (2012-11-28)</p>
</li>
<li><p class="first">v.0.5.1 Removed unit tests that are no longer required (2012-08-30)</p>
</li>
<li><p class="first">v.0.5.0 Added support for Historic queries and Push delivery (2012-08-27)</p>
</li>
<li><p class="first">v.0.4.0 Fixed issues with SSL timeouts &amp; low throughput streams (2012-08-08)</p>
</li>
<li><p class="first">v.0.3.0 Added SSL support and fixed a reconnection bug (2012-05-16)</p>
<p>The SSL support is enabled by default and can be disabled by passing false as
the third parameter to the User constructor, or calling enableSSL(false) on
the User object.</p>
</li>
<li><p class="first">v.0.2.0 Fixed the handling of error messages in streams (2012-05-04)</p>
</li>
<li><p class="first">v.0.1.1 Initial release (2012-03-09)</p>
</li>
</ul>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">DataSift Python Client Library</a><ul>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#usage">Usage</a></li>
<li><a class="reference internal" href="#supported-operating-environment">Supported Operating Environment</a><ul>
<li><a class="reference internal" href="#language-versions">Language versions</a></li>
<li><a class="reference internal" href="#operating-systems">Operating Systems</a></li>
</ul>
</li>
<li><a class="reference internal" href="#style-guide">Style Guide</a></li>
<li><a class="reference internal" href="#requirements">Requirements</a></li>
<li><a class="reference internal" href="#license">License</a></li>
<li><a class="reference internal" href="#changelog">Changelog</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="index.html"
                        title="previous chapter">Welcome to the datasift Python module</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="gettingstarted.html"
                        title="next chapter">Getting Started</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/readme.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="gettingstarted.html" title="Getting Started"
             >next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Welcome to the datasift Python module"
             >previous</a> |</li>
        <li><a href="index.html">datasift 2.0.11 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2014, MediaSift Ltd..
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
    </div>
  </body>
</html>
Something went wrong with that request. Please try again.