feat: Replace black + pylint w/ ruff

.github/workflows/ci.yml

@@ -20,13 +20,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: chartboost/ruff-action@v1
+      - uses: chartboost/ruff-action@v1
         with:
-          python-version: ${{ env.PYTHON_VERSION }}
-      - run: pip install poetry==${{ env.POETRY_VERSION }}
-      - run: poetry install
-      - run: poetry run black --check axiom tests examples
-      - run: poetry run pylint -E axiom tests examples
+          args: 'format --check'
 
   test-integration:
     name: Test Integration
@@ -76,4 +73,4 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - run: pip install poetry==${{ env.POETRY_VERSION }}
-      - run: poetry publish --build -u __token__ -p "${{ secrets.PYPI_TOKEN }}"
+      - run: poetry publish --build -u __token__ -p "${{ secrets.PYPI_TOKEN }}"

axiom/__init__.py

@@ -2,8 +2,54 @@
 Axiom Python Client
 """
 
-__version__ = "0.1.0-beta.2"
+from .client import (
+    Error,
+    IngestFailure,
+    IngestStatus,
+    IngestOptions,
+    AplResultFormat,
+    ContentType,
+    ContentEncoding,
+    WrongQueryKindException,
+    AplOptions,
+    Client,
+)
+from .datasets import (
+    Dataset,
+    DatasetCreateRequest,
+    DatasetUpdateRequest,
+    TrimRequest,
+    Field,
+    DatasetInfo,
+    DatasetsClient,
+)
+from .annotations import (
+    Annotation,
+    AnnotationCreateRequest,
+    AnnotationUpdateRequest,
+    AnnotationsClient,
+)
 
-from .client import *
-from .datasets import *
-from .annotations import *
+_all_ = [
+    Error,
+    IngestFailure,
+    IngestStatus,
+    IngestOptions,
+    AplResultFormat,
+    ContentType,
+    ContentEncoding,
+    WrongQueryKindException,
+    AplOptions,
+    Client,
+    Dataset,
+    DatasetCreateRequest,
+    DatasetUpdateRequest,
+    TrimRequest,
+    Field,
+    DatasetInfo,
+    DatasetsClient,
+    Annotation,
+    AnnotationCreateRequest,
+    AnnotationUpdateRequest,
+    AnnotationsClient,
+]

axiom/annotations.py

@@ -3,9 +3,9 @@
 import ujson
 from logging import Logger
 from requests import Session
-from typing import List, Dict, Optional
+from typing import List, Optional
 from dataclasses import dataclass, asdict, field
-from datetime import datetime, timedelta
+from datetime import datetime
 from urllib.parse import urlencode
 from .util import Util
 
@@ -84,9 +84,9 @@ def list(
         query_params = {}
         if len(datasets) > 0:
             query_params["datasets"] = ",".join(datasets)
-        if start != None:
+        if start is not None:
             query_params["start"] = start.isoformat()
-        if end != None:
+        if end is not None:
             query_params["end"] = end.isoformat()
         path = f"/v2/annotations?{urlencode(query_params, doseq=True)}"
 

axiom/client.py

@@ -17,7 +17,7 @@
 from .query import QueryLegacy, QueryResult, QueryOptions, QueryLegacyResult, QueryKind
 from .annotations import AnnotationsClient
 from .users import UsersClient
-from .__init__ import __version__
+from .version import __version__
 
 
 AXIOM_URL = "https://api.axiom.co"

axiom/datasets.py

@@ -3,7 +3,7 @@
 import ujson
 from logging import Logger
 from requests import Session
-from typing import List, Dict
+from typing import List
 from dataclasses import dataclass, asdict, field
 from datetime import datetime, timedelta
 from .util import Util

axiom/query/__init__.py

@@ -1,5 +1,42 @@
-from .query import *
-from .options import *
-from .filter import *
-from .aggregation import *
-from .result import *
+from .query import QueryKind, Order, VirtualField, Projection, QueryLegacy
+from .options import QueryOptions
+from .filter import FilterOperation, BaseFilter, Filter
+from .aggregation import AggregationOperation, Aggregation
+from .result import (
+    MessageCode,
+    MessagePriority,
+    Message,
+    QueryStatus,
+    Entry,
+    EntryGroupAgg,
+    EntryGroup,
+    Interval,
+    Timeseries,
+    QueryLegacyResult,
+    QueryResult,
+)
+
+__all__ = (
+    QueryKind,
+    Order,
+    VirtualField,
+    Projection,
+    QueryLegacy,
+    QueryOptions,
+    FilterOperation,
+    BaseFilter,
+    Filter,
+    AggregationOperation,
+    Aggregation,
+    MessageCode,
+    MessagePriority,
+    Message,
+    QueryStatus,
+    Entry,
+    EntryGroupAgg,
+    EntryGroup,
+    Interval,
+    Timeseries,
+    QueryLegacyResult,
+    QueryResult,
+)

axiom/query/query.py

@@ -1,7 +1,7 @@
 from enum import Enum
 from typing import List, Optional
 from dataclasses import dataclass, field
-from datetime import datetime, timedelta
+from datetime import datetime
 from .aggregation import Aggregation
 from .filter import Filter
 

axiom/query/result.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass, field
-from datetime import datetime, timedelta
+from datetime import datetime
 from typing import List, Dict, Optional
 from enum import Enum
 

axiom/version.py

@@ -0,0 +1,3 @@
+"""The current version"""
+
+__version__ = "0.5.0"

examples/delete_dataset.py

@@ -1,7 +1,7 @@
-from axiom import Client, DatasetCreateRequest
+from axiom import Client
 
 
 def delete_dataset(dataset_name):
     client = Client()
     client.datasets.delete(dataset_name)
-    print(f"deleted dataset: my-dateset")
+    print("deleted dataset: my-dateset")

examples/ingest.py

@@ -4,4 +4,5 @@
 def ingest(dataset_name):
     client = Client()
     res = client.ingest_events(dataset_name, [{"foo": "bar"}])
-    print("Ingested %d events with %d failures".format(res.ingested, res.failed))
+    print(f"Ingested {len(res.ingested)} events with {
+          len(res.failures)} failures")

pyproject.toml

@@ -22,10 +22,9 @@ rfc3339 = "^6.2"
 iso8601 = ">=1.0.2,<3.0.0"
 
 [tool.poetry.dev-dependencies]
-black = "^24.4.2"
 pytest = "^8.2.1"
-pylint = "^3.2.1"
 responses = "^0.25.0"
+ruff = "^0.6.4"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

tests/test_annotations.py

@@ -3,10 +3,7 @@
 import os
 
 import unittest
-from typing import List, Dict, Optional
 from logging import getLogger
-from requests.exceptions import HTTPError
-from datetime import timedelta
 from .helpers import get_random_name
 from axiom import (
     Client,
@@ -36,7 +33,7 @@ def setUpClass(cls):
             name=cls.dataset_name,
             description="test_annotations.py (dataset_name)",
         )
-        res = cls.client.datasets.create(req)
+        cls.client.datasets.create(req)
 
     def test_happy_path_crud(self):
         """Test the happy path of creating, reading, updating, and deleting an annotation."""

tests/test_client.py

@@ -185,7 +185,7 @@ def test_step005_wrong_query_kind(self):
 
         try:
             self.client.query_legacy(self.dataset_name, q, opts)
-        except WrongQueryKindException as err:
+        except WrongQueryKindException:
             self.logger.info("passing kind apl to query raised exception as expected")
             return