Skip to main content

Search functionality of COAST

Project description

==========
COAST_SEARCH
==========


.. image:: https://img.shields.io/pypi/v/coast_search.svg
:target: https://pypi.python.org/pypi/coast_search

.. image:: https://img.shields.io/travis/zedrem/coast_search.svg
:target: https://travis-ci.org/zedrem/coast_search

.. image:: https://readthedocs.org/projects/coast-search/badge/?version=latest
:target: https://coast-search.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status




COAST_SEARCH allows you to generate and run queries against the Google Custom Search API.

* Free software: MIT license
* Documentation: https://coast-search.readthedocs.io.


Features
--------
With COAST_SEARCH you can:

* Generate and run queries based on the multi-dimensional search logic outlined by Rainer and Williams in `IST'18`_
* Define your own queries to run

.. _IST'18: https://www.sciencedirect.com/science/article/abs/pii/S0950584918302192


Prerequisites
-------------
The tool is built in Python 3 and tested in versions 3.5 and 3.6.

You are required to set up and provide your own API keys and Search Engine ID's for searching against the Google Custom Search API. Details on how to do so can be found `online here`_

.. _online here: https://developers.google.com/custom-search/v1/overview

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

To install COAST_SEARCH, run this command in your terminal:

.. code-block:: console

$ pip install coast_search

This is the preferred method to install COAST_SEARCH, as it will always install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

To install from source, visit our documentation_.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/

.. _documentation: https://coast-search.readthedocs.io


.. :changelog:

History
-------

+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| Date | Status |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| April 2016 | Research on credibility begins, some initial scripts are written as part of various studies |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| First half of 2017 | Adrien Aucher joins UC as an intern and works with Ashley Williams on the first version of this tool. It is only used internally at this point. |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| November 2018 | Liz Richardson and Stefan Hall join the project to work on the first release. |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| December 2018 | Version 1.0.0 released. |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+


Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for coast-search, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size coast_search-1.0.0-py2.py3-none-any.whl (15.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size coast_search-1.0.0.tar.gz (31.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page