Metadata-Version: 2.1
Name: frisbee
Version: 0.0.2
Summary: Search tool to find email addresses by abusing search
Home-page: https://github.com/9b/frisbee
Author: Brandon Dixon
Author-email: brandon@9bplus.com
License: MIT
Download-URL: https://github.com/9b/frisbee/archive/master.zip
Keywords: emails,leads,search engine,crawler,intel
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries
Requires-Dist: beautifulsoup4
Requires-Dist: requests
Requires-Dist: requests-futures
Requires-Dist: namesgenerator

Frisbee
=======
.. image:: https://readthedocs.org/projects/frisbee/badge/?version=latest
    :target: http://frisbee.readthedocs.io/en/latest/?badge=latest

.. image:: https://badge.fury.io/py/frisbee.svg
    :target: https://badge.fury.io/py/frisbee

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
    :target: https://opensource.org/licenses/MIT


Frisbee is a small utility to collect email addresses from search engines and
other free-form text sources. Frisbee makes it simple to find email addresses
posted on the web by taking user-fed input and translating it into an
automated search query. Users can extend frisbee by adding modules for new
search engines or other obscure data sources.

For detailed explanations of the library, please see the wiki_.

.. _wiki: https://github.com/9b/frisbee/wiki

Quick Start
-----------
**Install the library**:

``pip install frisbee`` or ``python setup.py install``

**Run a search**

``frisbee search -e bing -d bnpparibas.com -l 50 --greedy --save``


Sample Code
-----------

This sample code shows some of the range of functionality within the module::

    from frisbee import Frisbee

    # Create an instance
    frisbee = Frisbee(save=True)

    # Describe your job
    jobs = [{'engine': 'bing', 'modifier': 'site:github.com',
             'domain': 'foo.bar', 'limit': 50}]

    # Execute the jobs
    frisbee.search(jobs)

    # Get the results
    results = frisbee.get_results()

Example Output
--------------

Below is an example job result::

    [{
        "engine": "bing",
        "modifier": "site:github.com",
        "domain": "blockade.io",
        "limit": 50,
        "results": {
            "start_time": "2018-12-13 16:54:15",
            "end_time": "2018-12-13 16:54:19",
            "emails": [
                "info@blockade.io"
            ],
            "duration": "4",
            "processed": 44
        },
        "project": "zealous_kirch"
    }]

Features
--------
* Ability to search for email addresses from search engine results
* Modular design that can be extended easily to include new sources
* Modifier options that can filter or target search query
* Limit option to reduce the number of results parsed
* Greedy option to learn from collected results
* Save output describing job request and results

Changelog
---------
12-14-18
~~~~~~~~
* Feature: Activated greedy option to save and output to screen
* Bugfix: Wrapped loading of HTML for cases where data is dirty

12-13-18
~~~~~~~~
* Initial push!

