Metadata-Version: 2.1
Name: pysigsci
Version: 3.1.1
Summary: A python wrapper for the Signal Sciences API - https://docs.signalsciences.net/api/
Home-page: https://github.com/foospidy/pysigsci
Author: foospidy
Author-email: UNKNOWN
License: MIT
Download-URL: https://github.com/foospidy/pysigsci
Keywords: wrapper library signal sciences sigsci pysigsci api cli
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 2.7
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: requests
Requires-Dist: pyopenssl
Requires-Dist: deepdiff
Requires-Dist: gitpython

Signal Sciences
==================

.. image:: https://img.shields.io/pypi/v/pysigsci.svg
    :target: https://pypi.python.org/pypi/pysigsci/
    :alt: Latest Version

.. image:: https://travis-ci.org/foospidy/pysigsci.svg?branch=master
    :target: https://travis-ci.org/foospidy/pysigsci

``pysigsci`` is a Python wrapper and CLI tool for the `Signal Sciences REST API`_.

Installation
------------
.. code-block:: bash

    $ pip install pysigsci

CLI usage
---------
.. code-block:: bash

    $ pysigsci --get requests

To see all options run: $ pysigsci --help

CLI configuration audit tool
----------------------------
.. code-block:: bash

    $ pysigscia --get-config
    $ pysigscia --compare site1 --to site2

To see all options run: $ pysigscia --help

Module usage
------------
.. code-block:: python

    from pysigsci import sigsciapi
    sigsci = sigsciapi.SigSciApi(email="myemail", password="mypassword")
    sigsci.corp = "mycorp"
    sigsci.site = "mysite"

    params = {"q": "from:-1d tag:XSS"}
    print(sigsci.get_requests(parameters=params))

More details and the latest updates can be found on the `GitHub Project Page`_.

.. _Signal Sciences REST API: https://docs.signalsciences.net/api/
.. _GitHub Project Page: https://github.com/foospidy/pysigsci

