Metadata-Version: 2.1
Name: StackAPI
Version: 0.3.1
Summary: Library for interacting with the Stack Exchange API
Home-page: https://github.com/AWegnerGitHub/StackAPI
Author: Andrew Wegner
Author-email: pypi@andrewwegner.com
Maintainer: Andrew Wegner
Maintainer-email: pypi@andrewwegner.com
License: MIT
Keywords: stackexchange
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
License-File: LICENSE.txt
License-File: AUTHORS.rst
Requires-Dist: requests
Requires-Dist: six

This is a Python wrappers for the `Stack Exchange
API <http://api.stackexchange.com/>`__. This library supports Stack
Exchange API v2.3.

.. image:: https://readthedocs.org/projects/stackapi/badge/?version=latest
  :target: http://stackapi.readthedocs.io/en/latest/?badge=latest
  :alt: Documentation Status

This library has support for:

-  The Stack Exchange backoff parameter. It will automatically force a
   delay to match the parameter.
-  Read and write functionality via the API.
-  Can retrieve multiple pages of results with a single call and merges
   all the results into a single response.
-  Throws exceptions returned by the API for easier troubleshooting.
-  Utilizes `Requests <http://docs.python-requests.org/>`__.
-  `Stack Overflow for Teams <https://stackoverflow.co/teams/>`_ API


Example usage:
==============

Establish a connection to Stack Overflow and gather some comments
-----------------------------------------------------------------

::

    from stackapi import StackAPI
    SITE = StackAPI('stackoverflow')
    comments = SITE.fetch('comments')

The above, will issue a call to the
|comments|_. end point on Stack Overflow.

.. |comments| replace:: ``comments``
.. _comments: http://api.stackexchange.com/docs/comments

Much more detailed documentation is available on
`ReadTheDocs <http://stackapi.readthedocs.io/>`__.
