Metadata-Version: 2.0
Name: twingly-search
Version: 1.2.1
Summary: Python library for Twingly Search API
Home-page: https://github.com/twingly/twingly-search-api-python
Author: Twingly AB
Author-email: support@twingly.com
License: MIT
Keywords: twingly
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: future
Requires-Dist: requests

Twingly Search API Python
=========================

|Build Status|

A Python library for Twingly's Search API (previously known as Analytics
API). Twingly is a blog search service that provides a searchable API
known as `Twingly Search
API <https://developer.twingly.com/resources/search/>`__.

Installation
------------

Install via PyPI

.. code:: shell

    pip install twingly-search

Or add ``twingly-search`` to your application's `requirements
file <https://pip.pypa.io/en/stable/user_guide/#requirements-files>`__
and then run

.. code:: shell

    pip install -r requirements.txt

Or from source code

.. code:: shell

    git clone https://github.com/twingly/twingly-search-api-python.git
    cd twingly-search-api-python
    python setup.py install

Usage
-----

.. code:: python

    from twingly_search import Client

    client = Client()

    query = client.query()
    query.pattern = 'github page-size:10'
    query.language = 'sv'

    # Assumes UTC if no timezone is specified
    query.start_time = datetime.datetime(2015, 2, 23, 15, 18, 13)

    result = query.execute()

    for post in result.posts:
        print post.url

Example code can be found in `examples/ <examples/>`__.

The ``twingly_search`` library talks to a commercial blog search API and
requires an API key. Best practice is to set the ``TWINGLY_SEARCH_KEY``
environment variable to the obtained key. ``twingly_search.Client`` can
be passed a key at initialization if your setup does not allow
environment variables.

To learn more about the capabilities of the API, please read the
`Twingly Search API
documentation <https://developer.twingly.com/resources/search/>`__.

Documentation
~~~~~~~~~~~~~

``twingly_search`` is documented with
`pydoc <https://docs.python.org/2/library/pydoc.html>`__. To read the
documentation directly in your console you can run

.. code:: shell

    pydoc twingly_search

or you can start a local pydoc web server with

.. code:: shell

    pydoc -p 1234 twingly_search

In this case documentation will be available at
http://localhost:1234/twingly_search.html

Requirements
------------

-  API key, `sign up <https://www.twingly.com/try-for-free>`__ via
   `twingly.com <https://www.twingly.com/>`__ to get one
-  Python 2.7+, 3.0+ with
   `SNI <https://en.wikipedia.org/wiki/Server_Name_Indication>`__
   support, see `Requests
   FAQ <http://docs.python-requests.org/en/master/community/faq/#what-are-hostname-doesn-t-match-errors>`__
   for more information

Development
-----------

Tests
~~~~~

Install the tests dependencies

::

    make deps

Run the tests

::

    make test

Release
~~~~~~~

To be able to publish the package, create a `.pypirc
file <https://docs.python.org/2/distutils/packageindex.html#pypirc>`__
containing your pypi username an password.

You will need pandoc to convert README.md to reStructuredText:

::

    brew install pandoc
    pip install pypandoc

Bump the version in `setup.py <./setup.py>`__ and
`\_\ *init\_*.py <./twingly-search/__init__.py>`__.

Publish to `PyPi <https://pypi.python.org/pypi/twingly-search>`__:

::

    ./publish-to-pypi.sh

License
-------

The MIT License (MIT)

Copyright (c) 2016 Twingly AB

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

.. |Build Status| image:: https://travis-ci.org/twingly/twingly-search-api-python.png?branch=master
   :target: https://travis-ci.org/twingly/twingly-search-api-python


