semvec/pypi-packages huggingface dataset:
punter 0.1.2
Python wrapper for the Email Hunter API
License: MIT

punter
======

|status| |version| |license|

A tiny python wrapper for the `Email Hunter
API <https://emailhunter.co/api>`__. Seriously. It's tiny.

Usage
-----

In most cases the primary usage will be executing searches on a domain.

.. code:: python

    >>> import punter
    >>> s = punter.search('d08d2ba22218d1b59df239d03fc5e66adfaec2b2', 'stripe.com')
    >>> s['status']
    u'success'
    >>> s['results']
    164
    >>> s['emails']
    [{
        "status": "success",
        "results": 164,
        "webmail": false,
        "pattern": "{first}"
        "offset": 0,
        "emails": [
            {
              "value": "hoon@stripe.com",
              "type": "personal",
              "sources": [
                {
                  "domain": "stripe.com",
                  "uri": "https://stripe.com/blog/weekly-and-monthly-transfers",
                  "extracted_on": "2015-03-05"
                }
              ]
            },
        ...
        ]
    }]

Want to do an email search? Essentially the same deal.

.. code:: python

    >>> import punter
    >>> s = punter.search('d08d2ba22218d1b59df239d03fc5e66adfaec2b2', 'apple-pay@stripe.com')
    >>> s['status']
    u'success'
    >>> s['exist']
    True
    >>> s['email']
    u'apple-pay@stripe.com'
    >>> s['emails']
    [{
        u'domain': u'mpora.com', 
        u'extracted_on': u'2015-04-27', 
        u'uri': u'http://mpora.com/tags/wolfgang-wildner'
    }]

Install
-------

.. code:: bash

    $ pip install punter

Todo
----

There's always room for improvement.

-  More Pythonic!
-  Tighten up the exception handling
-  Tox configuration
-  Perhaps make a cli (new project?)

License
-------

The MIT License (MIT)

Copyright (c) 2015 Joshua Goodlett

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.

.. |status| image:: https://img.shields.io/travis/jgoodlet/punter.svg
   :target: https://travis-ci.org/jgoodlet/punter.svg
.. |version| image:: https://img.shields.io/pypi/v/punter.svg
   :target: https://pypi.python.org/pypi/punter
.. |license| image:: https://img.shields.io/pypi/l/punter.svg
   :target: https://pypi.python.org/pypi/punter