Metadata-Version: 2.1
Name: greynoise
Version: 0.4.1
Summary: Abstraction to interact with GreyNoise API.
Home-page: https://greynoise.io/
Author: GreyNoise Intelligence
Author-email: hello@greynoise.io
License: MIT
Download-URL: https://github.com/GreyNoise-Intelligence/pygreynoise
Keywords: internet,scanning,threat intelligence,security
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: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
Requires-Dist: Click (>=7.0)
Requires-Dist: ansimarkup
Requires-Dist: cachetools
Requires-Dist: click-default-group
Requires-Dist: click-repl
Requires-Dist: dicttoxml
Requires-Dist: jinja2
Requires-Dist: more-itertools
Requires-Dist: requests
Requires-Dist: six
Requires-Dist: structlog

================
Python GreyNoise
================

.. image:: https://circleci.com/gh/GreyNoise-Intelligence/pygreynoise.svg?style=shield
    :target: https://circleci.com/gh/GreyNoise-Intelligence/pygreynoise

.. image:: https://sonarcloud.io/api/project_badges/measure?project=GreyNoise-Intelligence_pygreynoise&metric=coverage
    :target: https://sonarcloud.io/dashboard?id=GreyNoise-Intelligence_pygreynoise

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

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


.. image:: https://pyup.io/repos/github/GreyNoise-Intelligence/pygreynoise/shield.svg
    :target: https://pyup.io/repos/github/GreyNoise-Intelligence/pygreynoise/
    :alt: Updates

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

.. image:: https://quay.io/repository/greynoiseintel/pygreynoise/status
    :target: https://quay.io/repository/greynoiseintel/pygreynoise

This is an abstract python library built on top of the `GreyNoise`_ service. It is preferred that users use this library when implementing integrations or plan to use GreyNoise within their code. The library includes a small client to interact with the API.

.. _GreyNoise: https://greynoise.io/

Quick Start
===========
**Install the library**:

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

**Save your configuration**:

``greynoise setup --api-key <your-API-key>``

Usage
=====
::

    Usage: greynoise [OPTIONS] COMMAND [ARGS]...

      GreyNoise CLI.

    Options:
      -h, --help  Show this message and exit.

    Commands:
      query*       Run a GNQL (GreyNoise Query Language) query.
      account      View information about your GreyNoise account.
      alerts       List, create, delete, and manage your GreyNoise alerts.
      analyze      Analyze the IP addresses in a log file, stdin, etc.
      feedback     Send feedback directly to the GreyNoise team.
      filter       "Filter the noise from a log file, stdin, etc.
      help         Show this message and exit.
      interesting  Report an IP as "interesting".
      ip           Query GreyNoise for all information on a given IP.
      pcap         Get PCAP for a given IP address.
      quick        Quickly check whether or not one or many IPs are "noise".
      repl         Start an interactive shell.
      setup        Configure API key.
      signature    Submit an IDS signature to GreyNoise to be deployed to all...
      stats        Get aggregate stats from a given GNQL query.
      version      Get version and OS information for your GreyNoise
                   commandline...



=========
Changelog
=========

Version `0.4.1`_
================
**Date**: Jan 3, 2020

* API client:
  * add ``spoofable`` field.

Version `0.4.0`_
================
**Date**: November 18, 2019

* API client:
  * add ``interesting`` method.
  * add ``filter`` method.
  * add ``analyze`` method.
  * add ``scroll`` and ``size`` parameters to ``query`` method.
  * add ``api_server`` and ``integration_name`` parameters to ``__init__`` method.

* CLI:
  * add ``interesting`` subcommand.
  * add ``filter`` subcommand.
  * add ``analyze`` subcommand.
  * add ``api_server`` option to setup subcommand.

* Both API client and CLI:
  * use structlog logging library.

Version `0.3.0`_
================
**Date**: September 06, 2019

* API client:

  * rename API client methods to match CLI command names.
  * use LRU cache for IP context and quick check calls.

* CLI:

  * add help, repl and version subcommands.
  * global options moved to those subcommands where they apply.
  * make request timeout configurable.


Version `0.2.2`_
================
**Date**: August 28, 2019

* CLI: fix ``setup`` subcommand when configuration directory doesn't exist.


Version `0.2.1`_
================
**Date**: August 28, 2019

* API client

  * Version sent in ``User-Agent`` header.
  * Raise ``RateLimitError`` on 429 response.

* CLI

  * Colored output.
  * Add ``-i / --input`` option.


Version `0.2.0`_
================
**Date**: August 21, 2019

* Complete codebase refactoring.


.. _`0.2.0`: https://github.com/GreyNoise-Intelligence/pygreynoise/compare/df4af7c392c50a5a0ebb5d761d7c67de6208c2c1...v0.2.0
.. _`0.2.1`: https://github.com/GreyNoise-Intelligence/pygreynoise/compare/v0.2.0...v0.2.1
.. _`0.2.2`: https://github.com/GreyNoise-Intelligence/pygreynoise/compare/v0.2.1...v0.2.2
.. _`0.3.0`: https://github.com/GreyNoise-Intelligence/pygreynoise/compare/v0.2.2...v0.3.0
.. _`0.4.0`: https://github.com/GreyNoise-Intelligence/pygreynoise/compare/v0.3.0...0.4.0
.. _`0.4.1`: https://github.com/GreyNoise-Intelligence/pygreynoise/compare/v0.4.0...0.4.1


