graylog-api-client 0.1.1__tar.gz → 0.1.3__tar.gz

{graylog_api_client-0.1.1 → graylog_api_client-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: graylog-api-client
-Version: 0.1.1
+Version: 0.1.3
 Summary: A Python wrapper for the Graylog REST API
 License-Expression: MIT
 License-File: LICENSE
@@ -21,6 +21,25 @@ Also the API responses all follow very different schemas and an implementation o
 Feel free to add endpoints or schemas in PRs if you need them :)
 #### Last tested Graylog Version is: 6.3.4
 
+### Example Usage
+
+```python
+from graylog_api_client import GraylogAPI
+
+# Initialize the GraylogAPI client
+api = GraylogAPI(
+    host="https://localhost:9000/api",  # Replace with your Graylog server URL
+    api_key="your_api_key_here",       # Replace with your API key
+    ssl_verify=True                   # /path/to/cert for custom certificate
+)
+
+# Example: Fetch all streams
+streams = api.get_streams()
+
+# Print the result
+print("Streams:", streams.data)
+```
+
 Planned:
 1. Tests that run against a Graylog instance to check if the Wrapper works after Graylog Updates
 

{graylog_api_client-0.1.1 → graylog_api_client-0.1.3}/README.md

@@ -4,6 +4,25 @@ Also the API responses all follow very different schemas and an implementation o
 Feel free to add endpoints or schemas in PRs if you need them :)
 #### Last tested Graylog Version is: 6.3.4
 
+### Example Usage
+
+```python
+from graylog_api_client import GraylogAPI
+
+# Initialize the GraylogAPI client
+api = GraylogAPI(
+    host="https://localhost:9000/api",  # Replace with your Graylog server URL
+    api_key="your_api_key_here",       # Replace with your API key
+    ssl_verify=True                   # /path/to/cert for custom certificate
+)
+
+# Example: Fetch all streams
+streams = api.get_streams()
+
+# Print the result
+print("Streams:", streams.data)
+```
+
 Planned:
 1. Tests that run against a Graylog instance to check if the Wrapper works after Graylog Updates
 

{graylog_api_client-0.1.1 → graylog_api_client-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "graylog-api-client"
-version = "0.1.1"
+version = "0.1.3"
 description = "A Python wrapper for the Graylog REST API"
 authors = [
     {name = "Chrxxxxs",email = "134285960+Chrxxxxs@users.noreply.github.com"}
@@ -22,3 +22,8 @@ packages = [{include = "graylog_api_client", from = "src"}]
 [build-system]
 requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.1.1",
+]

graylog_api_client-0.1.3/src/graylog_api_client/__init__.py

@@ -0,0 +1,3 @@
+from graylog_api_client.graylog_api_client import GraylogAPI
+
+__all__ = ["GraylogAPI"]

{graylog_api_client-0.1.1 → graylog_api_client-0.1.3}/src/graylog_api_client/data_structures.py

@@ -12,3 +12,15 @@ class GraylogApiResult:
         self.status_code = int(status_code)
         self.message = str(message)
         self.data = data if data else []
+
+
+# TODO make this a proper class
+class GraylogTimerange:
+    # Example relative:
+    # { "type": "relative", "range": 300 }
+    # Example absolute:
+    # { "type": "absolute", "from": "2023-01-01T00:00:00.000Z", "to": "2023-01-02T00:00:00.000Z" }
+    def relative(range: int):
+        ...
+    def absolute(from_time: str, to_time: str):
+        ...

{graylog_api_client-0.1.1 → graylog_api_client-0.1.3}/src/graylog_api_client/graylog_api_client.py

@@ -1,5 +1,5 @@
 import logging
-from typing import List, Union, Dict
+from typing import List, Literal, Union, Dict
 
 from .rest_adapter import RestAdapter
 from .data_structures import GraylogApiResult
@@ -7,6 +7,13 @@ from .data_structures import GraylogApiResult
 
 class GraylogAPI:
     def __init__(self, host: str, api_key: str, ssl_verify: Union[str, bool] = True, logger: logging.Logger = None):
+        """GraylogAPI client
+
+        :param host: The hostname of the Graylog API endpoint plus the protocol. Example: https://graylog.com/api
+        :param api_key: An API Key to authenticate with Graylog
+        :param ssl_verify: Enables or Disables TLS Certificate verification. For a custom certificate, this value must a path pointing to the certificate, defaults to True
+        :param logger: The logger being used by the Adapter, will use a new one if none is given, defaults to None
+        """
         self._rest_adapter = RestAdapter(host=host, api_key=api_key, ssl_verify=ssl_verify, logger=logger)
 
     # The endpoints grouped like they are in the api-browser
@@ -77,6 +84,24 @@ class GraylogAPI:
     # /roles
     # /views/search Search
     # /search Search Options (Decorators, Export, Functions etc.)
+    def post_search_query(self, query: str, start: int, timerange: dict, streams: list[str], stream_categories: list[str] = None,\
+                          sort: str = None, sort_order: Literal["Ascending", "Descending"] = None,\
+                          fields: list[str] = None, size: int = 50) -> GraylogApiResult:
+        """start replaces the "from" parameter in the API"""
+        data = {
+            "query": query,
+            "from": str(start),
+            "timerange": timerange,
+            "streams": streams,
+            "stream_categories": stream_categories,
+            "sort": sort,
+            "sort_order": sort_order,
+            "fields": fields,
+            "size": str(size),
+        }
+        result = self._rest_adapter.post("search/messages", data=data)
+        return result
+    
     # /views/searchjobs Searchjobs
     # /sidecars
     # /sidecar