SPHINXOPTS =

SPHINXBUILD = sphinx-build

PAPER =

BUILDDIR = _build

ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)

$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)

PAPEROPT_a4 = -D latex_paper_size=a4

PAPEROPT_letter = -D latex_paper_size=letter

ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext

help:

@echo "Please use \`make <target>' where <target> is one of"

@echo " html to make standalone HTML files"

@echo " dirhtml to make HTML files named index.html in directories"

@echo " singlehtml to make a single large HTML file"

@echo " pickle to make pickle files"

@echo " json to make JSON files"

@echo " htmlhelp to make HTML files and a HTML help project"

@echo " qthelp to make HTML files and a qthelp project"

@echo " devhelp to make HTML files and a Devhelp project"

@echo " epub to make an epub"

@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"

@echo " latexpdf to make LaTeX files and run them through pdflatex"

@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"

@echo " text to make text files"

@echo " man to make manual pages"

@echo " texinfo to make Texinfo files"

@echo " info to make Texinfo files and run them through makeinfo"

@echo " gettext to make PO message catalogs"

@echo " changes to make an overview of all changed/added/deprecated items"

@echo " xml to make Docutils-native XML files"

@echo " pseudoxml to make pseudoxml-XML files for display purposes"

@echo " linkcheck to check all external links for integrity"

@echo " doctest to run all doctests embedded in the documentation (if enabled)"

clean:

rm -rf $(BUILDDIR)/*

html:

$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

@echo

@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml:

$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

@echo

@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml:

$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml

@echo

@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

pickle:

$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle

@echo

@echo "Build finished; now you can process the pickle files."

json:

$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json

@echo

@echo "Build finished; now you can process the JSON files."

htmlhelp:

$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp

@echo

@echo "Build finished; now you can run HTML Help Workshop with the" \

".hhp project file in $(BUILDDIR)/htmlhelp."

qthelp:

$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp

@echo

@echo "Build finished; now you can run "qcollectiongenerator" with the" \

".qhcp project file in $(BUILDDIR)/qthelp, like this:"

@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Twython.qhcp"

@echo "To view the help file:"

@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Twython.qhc"

devhelp:

$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp

@echo

@echo "Build finished."

@echo "To view the help file:"

@echo "# mkdir -p $$HOME/.local/share/devhelp/Twython"

@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Twython"

@echo "# devhelp"

epub:

$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub

@echo

@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

latex:

$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

@echo

@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."

@echo "Run \`make' in that directory to run these through (pdf)latex" \

"(use \`make latexpdf' here to do that automatically)."

latexpdf:

$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

@echo "Running LaTeX files through pdflatex..."

$(MAKE) -C $(BUILDDIR)/latex all-pdf

@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

latexpdfja:

$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

@echo "Running LaTeX files through platex and dvipdfmx..."

$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja

@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

text:

$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text

@echo

@echo "Build finished. The text files are in $(BUILDDIR)/text."

man:

$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man

@echo

@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

texinfo:

$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo

@echo

@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."

@echo "Run \`make' in that directory to run these through makeinfo" \

"(use \`make info' here to do that automatically)."

info:

$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo

@echo "Running Texinfo files through makeinfo..."

make -C $(BUILDDIR)/texinfo info

@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

gettext:

$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale

@echo

@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

changes:

$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes

@echo

@echo "The overview file is in $(BUILDDIR)/changes."

linkcheck:

$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck

@echo

@echo "Link check complete; look for any errors in the above output " \

"or in $(BUILDDIR)/linkcheck/output.txt."

doctest:

$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest

@echo "Testing of doctests in the sources finished, look at the " \

"results in $(BUILDDIR)/doctest/output.txt."

xml:

$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml

@echo

@echo "Build finished. The XML files are in $(BUILDDIR)/xml."

pseudoxml:

$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml

@echo

@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

# Sphinx build info version 1

# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.

config: bfb67ab370c0e278534d9b496b14ab4f

tags: a205e9ed8462ae86fdd2f73488852ba9

.. _api:

Developer Interface

===================

.. module:: twython

This page of the documentation will cover all methods and classes available to the developer.

Twython, currently, has two main interfaces:

- Twitter's Core API (updating statuses, getting timelines, direct messaging, etc)

- Twitter's Streaming API

Core Interface

--------------

.. autoclass:: Twython

:special-members: __init__

:inherited-members:

Streaming Interface

-------------------

.. autoclass:: TwythonStreamer

:special-members: __init__

:inherited-members:

Streaming Types

~~~~~~~~~~~~~~~

.. autoclass:: twython.streaming.types.TwythonStreamerTypes

:inherited-members:

.. autoclass:: twython.streaming.types.TwythonStreamerTypesStatuses

:inherited-members:

Exceptions

----------

.. autoexception:: TwythonError

.. autoexception:: TwythonAuthError

.. autoexception:: TwythonRateLimitError

.. Twython documentation master file, created by

sphinx-quickstart on Thu May 30 22:31:25 2013.

You can adapt this file completely to your liking, but it should at least

contain the root `toctree` directive.

Twython

=======

| Actively maintained, pure Python wrapper for the Twitter API. Supports both normal and streaming Twitter APIs

Features

--------

- Query data for:

- User information

- Twitter lists

- Timelines

- Direct Messages

- and anything found in `the Twitter API docs <https://dev.twitter.com/docs/api/1.1>`_.

- Image Uploading!

- **Update user status with an image**

- Change user avatar

- Change user background image

- Change user banner image

- Support for Twitter's Streaming API

- Seamless Python 3 support!

Usage

-----

.. toctree::

:maxdepth: 2

usage/install

usage/starting_out

usage/basic_usage

Twython API Documentation

-------------------------

.. toctree::

:maxdepth: 2

api

.. _basic-usage:

Basic Usage

===========

This section will cover how to use Twython and interact with some basic Twitter API calls

Before you make any API calls, make sure you :ref:`authenticated <starting-out>` the user!

Create a Twython instance with your application keys and the users OAuth tokens::

from twython import Twython

twitter = Twython(APP_KEY, APP_SECRET

OAUTH_TOKEN, OAUTH_TOKEN_SECRET)

.. admonition:: Important

All sections on this page will assume you're using a Twython instance

What Twython Returns

--------------------

Twython returns a dictionary of JSON response from Twitter

User Information

----------------

Documentation: https://dev.twitter.com/docs/api/1.1/get/account/verify_credentials

::

twitter.verify_credentials()

Authenticated Users Home Timeline

---------------------------------

Documentation: https://dev.twitter.com/docs/api/1.1/get/statuses/home_timeline

::

twitter.get_home_timeline()

Search

------

Documentation: https://dev.twitter.com/docs/api/1.1/get/search/tweets

::

twitter.search(q='python')

To help explain :ref:`dynamic function arguments <starting-out>` a little more, you can see that the previous call used the keyword argument ``q``, that is because Twitter specifies in their `search documentation <https://dev.twitter.com/docs/api/1.1/get/search/tweets>`_ that the search call accepts the parameter "q". You can pass mutiple keyword arguments. The search documentation also specifies that the call accepts the parameter "result_type"

::

twitter.search(q='python', result_type='popular')

Updating Status

---------------

Documentation: https://dev.twitter.com/docs/api/1/post/statuses/update

::

twitter.update_status(status='See how easy using Twython is!')

.. _install:

Installation

============

Information on how to properly install Twython

Pip or Easy Install

-------------------

Install Twython via `pip <http://www.pip-installer.org/>`_::

$ pip install twython

or, with `easy_install <http://pypi.python.org/pypi/setuptools>`_::

$ easy_install twython

But, hey... `that's up to you <http://www.pip-installer.org/en/latest/other-tools.html#pip-compared-to-easy-install>`_.

Source Code

-----------

Twython is actively maintained on GitHub

Feel free to clone the repository::

git clone git://github.com/ryanmcgrath/twython.git

`tarball <https://github.com/ryanmcgrath/twython/tarball/master>`_::

$ curl -OL https://github.com/ryanmcgrath/twython/tarball/master

`zipball <https://github.com/ryanmcgrath/twython/tarball/master>`_::

$ curl -OL https://github.com/ryanmcgrath/twython/zipball/master

Now that you have the source code, install it into your site-packages directory::

$ python setup.py install