greynoise 3.0.2__tar.gz → 3.0.3__tar.gz

{greynoise-3.0.2 → greynoise-3.0.3}/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.0.2
+current_version = 3.0.3
 tag = False
 commit = False
 

{greynoise-3.0.2 → greynoise-3.0.3}/CHANGELOG.rst

@@ -2,6 +2,14 @@
 Changelog
 =========
 
+Version `3.0.3`_
+================
+**Date**: May 15, 2026
+
+* API client:
+  * Add `exclude_fields` parameter to `query` command
+  * Update `stats` to use v3 endpoint
+
 Version `3.0.2`_
 ================
 **Date**: March 10, 2026
@@ -483,4 +491,5 @@ Version `0.2.0`_
 .. _`2.3.0`: https://github.com/GreyNoise-Intelligence/pygreynoise/compare/v2.2.0...2.3.0
 .. _`3.0.0`: https://github.com/GreyNoise-Intelligence/pygreynoise/compare/v2.3.0...v3.0.0
 .. _`3.0.1`: https://github.com/GreyNoise-Intelligence/pygreynoise/compare/v3.0.0...v3.0.1
-.. _`3.0.2`: https://github.com/GreyNoise-Intelligence/pygreynoise/compare/v3.0.1...HEAD
+.. _`3.0.2`: https://github.com/GreyNoise-Intelligence/pygreynoise/compare/v3.0.1...v3.0.2
+.. _`3.0.3`: https://github.com/GreyNoise-Intelligence/pygreynoise/compare/v3.0.2...HEAD

{greynoise-3.0.2 → greynoise-3.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: greynoise
-Version: 3.0.2
+Version: 3.0.3
 Summary: Abstraction to interact with GreyNoise API.
 Project-URL: Homepage, https://greynoise.io/
 Project-URL: Repository, https://github.com/GreyNoise-Intelligence/pygreynoise

{greynoise-3.0.2 → greynoise-3.0.3}/docs/source/conf.py

@@ -25,7 +25,7 @@ copyright = "2018-2025, GreyNoise Intelligence"
 author = "GreyNoise Intelligence"
 
 # The full version, including alpha/beta/rc tags
-release = "3.0.2"
+release = "3.0.3"
 
 
 # -- General configuration ---------------------------------------------------

{greynoise-3.0.2 → greynoise-3.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "greynoise"
-version = "3.0.2"
+version = "3.0.3"
 description = "Abstraction to interact with GreyNoise API."
 readme = {file = "README.rst", content-type = "text/x-rst"}
 requires-python = ">=3.8"

{greynoise-3.0.2 → greynoise-3.0.3}/src/greynoise/__version__.py

@@ -5,4 +5,4 @@ __license__ = "MIT"
 __maintainer__ = "GreyNoise Intelligence"
 __email__ = "support@greynoise.io"
 __status__ = "BETA"
-__version__ = "3.0.2"
+__version__ = "3.0.3"

{greynoise-3.0.2 → greynoise-3.0.3}/src/greynoise/api/__init__.py

@@ -249,7 +249,7 @@ class GreyNoise(BaseAPIClient):
     NAME = "GreyNoise"
     EP_GNQL = "v3/gnql"
     EP_GNQL_METADATA = "v3/gnql/metadata"
-    EP_GNQL_STATS = "v2/experimental/gnql/stats"
+    EP_GNQL_STATS = "v3/gnql/stats"
     EP_IP = "v3/ip/{ip_address}"
     EP_NOISE_MULTI = "v3/ip?quick=true"
     EP_NOISE_CONTEXT_MULTI = "v3/ip"
@@ -436,19 +436,58 @@ class GreyNoise(BaseAPIClient):
         response = self._request(endpoint)
         return response
 
-    def query(self, query, size=None, scroll=None, exclude_raw=False, quick=False):
-        """Run GNQL query."""
+    def query(
+        self,
+        query,
+        size=None,
+        scroll=None,
+        exclude_raw=False,
+        quick=False,
+        exclude_fields: Optional[Union[str, List[str]]] = None,
+    ) -> Dict[str, Any]:
+        """Run GNQL query.
+
+        :param query: GNQL query
+        :type query: str
+        :param size: Max number of results to return
+        :type size: int
+        :param scroll: Scroll token for pagination
+        :type scroll: str
+        :param exclude_raw: Whether to exclude raw results
+        :type exclude_raw: bool
+        :param quick: Whether to use quick lookup
+        :type quick: bool
+        :param exclude_fields: Field names to exclude; comma-separated string or list
+            of strings (sent to the API as the ``exclude`` query parameter).
+        :type exclude_fields: str or list[str]
+        """
         if self.offering == "community":
             response = {"message": "GNQL not supported with Community offering"}
         else:
             LOGGER.debug(
-                "Running GNQL query: %s %s %s %s...", query, size, scroll, quick
+                "Running GNQL query: %s %s %s %s %s...",
+                query,
+                size,
+                scroll,
+                quick,
+                exclude_fields,
             )
             params = {"query": query, "quick": quick}
             if size is not None:
                 params["size"] = size
             if scroll is not None:
                 params["scroll"] = scroll
+            if exclude_fields is not None:
+                if isinstance(exclude_fields, str):
+                    normalized_ef = ",".join(
+                        p.strip() for p in exclude_fields.split(",") if p.strip()
+                    )
+                else:
+                    normalized_ef = ",".join(
+                        str(p).strip() for p in exclude_fields if str(p).strip()
+                    )
+                if normalized_ef:
+                    params["exclude"] = normalized_ef
             if exclude_raw:
                 LOGGER.debug("Using GNQL Metadata endpoint")
                 endpoint = self.EP_GNQL_METADATA

{greynoise-3.0.2 → greynoise-3.0.3}/src/greynoise/cli/subcommand.py

@@ -170,6 +170,12 @@ def riot(
 
 
 @gnql_command
+@click.option(
+    "--exclude",
+    "exclude_fields",
+    default=None,
+    help="Comma-separated fields to omit from GNQL results (API ``exclude`` param).",
+)
 def query(
     context,
     api_client,
@@ -182,11 +188,15 @@ def query(
     size,
     scroll,
     offering,
+    exclude_fields,
 ):
     """Run a GNQL (GreyNoise Query Language) query."""
     queries = get_queries(context, input_file, query)
     results = [
-        api_client.query(query=item, size=size, scroll=scroll) for item in queries
+        api_client.query(
+            query=item, size=size, scroll=scroll, exclude_fields=exclude_fields
+        )
+        for item in queries
     ]
     return results
 

{greynoise-3.0.2 → greynoise-3.0.3}/tests/cli/test_subcommand.py

@@ -585,7 +585,9 @@ class TestQuery(object):
         result = runner.invoke(subcommand.query, ["-f", "json", query])
         assert result.exit_code == 0
         assert result.output.strip("\n") == expected
-        api_client.query.assert_called_with(query=query, size=None, scroll=None)
+        api_client.query.assert_called_with(
+            query=query, size=None, scroll=None, exclude_fields=None
+        )
 
     def test_input_file(self, api_client):
         """Run query from input file."""
@@ -598,7 +600,9 @@ class TestQuery(object):
         result = runner.invoke(subcommand.query, ["-f", "json", "-i", StringIO(query)])
         assert result.exit_code == 0
         assert result.output.strip("\n") == expected
-        api_client.query.assert_called_with(query=query, size=None, scroll=None)
+        api_client.query.assert_called_with(
+            query=query, size=None, scroll=None, exclude_fields=None
+        )
 
     def test_stdin_input(self, api_client):
         """Run query from stdin."""
@@ -611,7 +615,30 @@ class TestQuery(object):
         result = runner.invoke(subcommand.query, ["-f", "json"], input=query)
         assert result.exit_code == 0
         assert result.output.strip("\n") == expected
-        api_client.query.assert_called_with(query=query, size=None, scroll=None)
+        api_client.query.assert_called_with(
+            query=query, size=None, scroll=None, exclude_fields=None
+        )
+
+    def test_query_with_exclude(self, api_client):
+        """Run query with --exclude forwarded to the client."""
+        runner = CliRunner()
+
+        query = "<query>"
+        api_client.query.return_value = []
+        expected = json.dumps([[]], indent=4, sort_keys=True)
+
+        result = runner.invoke(
+            subcommand.query,
+            ["-f", "json", "--exclude", "raw_data,tls", query],
+        )
+        assert result.exit_code == 0
+        assert result.output.strip("\n") == expected
+        api_client.query.assert_called_with(
+            query=query,
+            size=None,
+            scroll=None,
+            exclude_fields="raw_data,tls",
+        )
 
     def test_no_query_passed(self, api_client):
         """Usage is returned if no query or input file is passed."""

{greynoise-3.0.2 → greynoise-3.0.3}/tests/test_api.py

@@ -727,6 +727,34 @@ class TestQuery(object):
         )
         assert response == expected_response
 
+    def test_query_exclude_fields_as_list(self, client):
+        """exclude_fields is sent as a comma-separated exclude query parameter."""
+        query = "<query>"
+        client._request = Mock(return_value=[])
+        client.query(query, exclude_fields=["raw_data", "tls"])
+        client._request.assert_called_with(
+            "v3/gnql",
+            params={
+                "query": query,
+                "quick": False,
+                "exclude": "raw_data,tls",
+            },
+        )
+
+    def test_query_exclude_fields_as_string(self, client):
+        """exclude_fields string is normalized to comma-separated names."""
+        query = "<query>"
+        client._request = Mock(return_value=[])
+        client.query(query, exclude_fields=" raw_data , tls ")
+        client._request.assert_called_with(
+            "v3/gnql",
+            params={
+                "query": query,
+                "quick": False,
+                "exclude": "raw_data,tls",
+            },
+        )
+
 
 class TestStats(object):
     """GreyNoise client run GNQL stats query test cases."""
@@ -738,9 +766,7 @@ class TestStats(object):
 
         client._request = Mock(return_value=expected_response)
         response = client.stats(query)
-        client._request.assert_called_with(
-            "v2/experimental/gnql/stats", params={"query": query}
-        )
+        client._request.assert_called_with("v3/gnql/stats", params={"query": query})
         assert response == expected_response