VER: Release Python client 0.5.0

Author: cjdsellers

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Changelog
 
-## 0.5.0 - TBD
- - Fixed columns for derived data schemas (dropped `channel_id`)
+## 0.5.0 - 2022-11-07
+ - Fixed dataframe columns for derived data schemas (dropped `channel_id`)
  - Fixed `batch.submit_job` requests for `dbz` encoding
  - Updated `quickstart.ipynb` jupyter notebook
 

databento/__init__.py

@@ -1,6 +1,22 @@
 from typing import Optional
 
 from databento.common.bento import Bento, FileBento, MemoryBento
+from databento.common.enums import (
+    Compression,
+    Dataset,
+    Delivery,
+    Encoding,
+    FeedMode,
+    Flags,
+    HistoricalGateway,
+    LiveGateway,
+    Packaging,
+    RollRule,
+    Schema,
+    SplitDuration,
+    SType,
+    SymbologyResolution,
+)
 from databento.historical.api import API_VERSION
 from databento.historical.client import Historical
 from databento.historical.error import (
@@ -19,9 +35,23 @@
     "BentoError",
     "BentoHttpError",
     "BentoServerError",
+    "Compression",
+    "Dataset",
+    "Delivery",
+    "Encoding",
+    "FeedMode",
     "FileBento",
+    "Flags",
     "Historical",
+    "HistoricalGateway",
+    "LiveGateway",
     "MemoryBento",
+    "Packaging",
+    "RollRule",
+    "Schema",
+    "SplitDuration",
+    "SType",
+    "SymbologyResolution",
 ]
 
 # Set to either 'DEBUG' or 'INFO', controls console logging

databento/common/parsing.py

@@ -141,9 +141,7 @@ def maybe_symbols_list_to_string(
         raise TypeError(f"invalid symbols type, was {type(symbols)}")
 
 
-def maybe_date_to_string(
-    value: Optional[Union[date, str]],
-) -> Optional[str]:
+def maybe_date_to_string(value: Optional[Union[date, str]]) -> Optional[str]:
     """
     Return a valid date string from the given value (if not None).
 
@@ -163,8 +161,25 @@ def maybe_date_to_string(
     return str(pd.to_datetime(value).date())
 
 
+def datetime_to_string(value: Union[pd.Timestamp, date, str, int]) -> str:
+    """
+    Return a valid datetime string from the given value.
+
+    Parameters
+    ----------
+    value : pd.Timestamp or date or str
+        The value to parse.
+
+    Returns
+    -------
+    str
+
+    """
+    return str(pd.to_datetime(value)).replace(" ", "T")
+
+
 def maybe_datetime_to_string(
-    value: Optional[Union[pd.Timestamp, date, str]],
+    value: Optional[Union[pd.Timestamp, date, str, int]],
 ) -> Optional[str]:
     """
     Return a valid datetime string from the given value (if not None).
@@ -182,7 +197,7 @@ def maybe_datetime_to_string(
     if value is None:
         return None
 
-    return str(pd.to_datetime(value)).replace(" ", "T")
+    return datetime_to_string(value)
 
 
 def parse_flags(value: int, apply_bitmask: bool = False) -> List[str]:

databento/historical/api/batch.py

@@ -48,7 +48,7 @@ def submit_job(
         limit: Optional[int] = None,
     ) -> Dict[str, Any]:
         """
-        Request a new time series data batch job from Databento.
+        Request a new time series data batch download from Databento.
 
         Makes a `POST /batch.submit_job` HTTP request.
 
@@ -94,7 +94,7 @@ def submit_job(
         Returns
         -------
         Dict[str, Any]
-            The job info for submitted batch download request.
+            The job info for batch download request.
 
         Warnings
         --------

databento/historical/http.py

@@ -11,8 +11,8 @@
 from databento.common.enums import Dataset, Schema, SType
 from databento.common.logging import log_info
 from databento.common.parsing import (
+    datetime_to_string,
     enum_or_str_lowercase,
-    maybe_datetime_to_string,
     maybe_symbols_list_to_string,
 )
 from databento.historical.error import BentoClientError, BentoServerError
@@ -52,8 +52,8 @@ def _timeseries_params(
     ) -> List[Tuple[str, Optional[str]]]:
         params: List[Tuple[str, Any]] = [
             ("dataset", enum_or_str_lowercase(dataset, "dataset")),
-            ("start", maybe_datetime_to_string(start)),
-            ("end", maybe_datetime_to_string(end)),
+            ("start", datetime_to_string(start)),
+            ("end", datetime_to_string(end)),
             ("symbols", maybe_symbols_list_to_string(symbols) or "*"),
             ("schema", schema.value),
             ("stype_in", stype_in.value),
@@ -83,7 +83,7 @@ def _check_api_key(self) -> None:
     def _get(
         self,
         url: str,
-        params: Optional[List[Tuple[str, str]]] = None,
+        params: Optional[List[Tuple[str, Optional[str]]]] = None,
         basic_auth: bool = False,
     ) -> Response:
         self._check_api_key()
@@ -103,7 +103,7 @@ def _get(
     async def _get_async(
         self,
         url: str,
-        params: Optional[List[Tuple[str, str]]] = None,
+        params: Optional[List[Tuple[str, Optional[str]]]] = None,
         basic_auth: bool = False,
     ) -> ClientResponse:
         self._check_api_key()
@@ -123,7 +123,7 @@ async def _get_async(
     def _post(
         self,
         url: str,
-        params: Optional[List[Tuple[str, str]]] = None,
+        params: Optional[List[Tuple[str, Optional[str]]]] = None,
         basic_auth: bool = False,
     ) -> Response:
         self._check_api_key()
@@ -143,7 +143,7 @@ def _post(
     def _stream(
         self,
         url: str,
-        params: List[Tuple[str, str]],
+        params: List[Tuple[str, Optional[str]]],
         basic_auth: bool,
         bento: Bento,
     ) -> None:

requirements_dev.txt

@@ -1,3 +1,3 @@
-pytest>=7.1.2
-pytest-mock>=3.8.1
+pytest>=7.2.0
+pytest-mock>=3.10.0
 types-requests

setup.cfg

@@ -14,3 +14,7 @@ ignore = C101, E203, W503
 # C101: Coding magic comment not found (not required as utf-8 is the default for python3).
 # E203: whitespace before ':' (conflicts with Black)
 # W503: in error will be amended by flake8 soon (https://www.flake8rules.com/rules/W503.html)
+
+[tool:pytest]
+testpaths = tests
+asyncio_mode = auto

setup.py

@@ -56,6 +56,7 @@
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
         "Topic :: Software Development :: Libraries",
         "Topic :: Software Development :: Libraries :: Python Modules",
         "Topic :: Office/Business :: Financial",

tests/test_historical_batch.py

@@ -7,7 +7,7 @@
 
 
 class TestHistoricalBatch:
-    def setup(self) -> None:
+    def setup_method(self) -> None:
         key = "DUMMY_API_KEY"
         self.client = db.Historical(key=key)
 

tests/test_historical_metadata.py

@@ -9,7 +9,7 @@
 
 
 class TestHistoricalMetadata:
-    def setup(self) -> None:
+    def setup_method(self) -> None:
         key = "DUMMY_API_KEY"
         self.client = db.Historical(key=key)