MOD: Rename batch.timeseries_submit to batch.submit_job

Author: cjdsellers

databento/historical/api/batch.py

@@ -30,7 +30,7 @@ def __init__(self, key, gateway):
         super().__init__(key=key, gateway=gateway)
         self._base_url = gateway + f"/v{API_VERSION}/batch"
 
-    def timeseries_submit(
+    def submit_job(
         self,
         dataset: Union[Dataset, str],
         symbols: Optional[Union[List[str], str]] = None,
@@ -48,9 +48,9 @@ def timeseries_submit(
         limit: Optional[int] = None,
     ) -> Dict[str, Any]:
         """
-        Request a new time series batch data job from Databento.
+        Request a new time series data batch job from Databento.
 
-        Makes a `POST /batch.timeseries_submit` HTTP request.
+        Makes a `POST /batch.submit_job` HTTP request.
 
         Parameters
         ----------
@@ -141,7 +141,7 @@ def timeseries_submit(
             params.append(("split_size", str(split_size)))
 
         return self._post(
-            url=self._base_url + ".timeseries_submit",
+            url=self._base_url + ".submit_job",
             params=params,
             basic_auth=True,
         ).json()
@@ -152,7 +152,7 @@ def list_jobs(
         since: Optional[Union[pd.Timestamp, date, str, int]] = None,
     ) -> List[Dict[str, Any]]:
         """
-        Request all batch data job details for the user account.
+        Request all batch job details for the user account.
 
         The job details will be sorted in order of `ts_received`.
 

databento/historical/api/timeseries.py

@@ -32,7 +32,7 @@ def stream(
         path: Optional[str] = None,
     ) -> Bento:
         """
-        Request a historical time series stream from Databento.
+        Request a historical time series data stream from Databento.
 
         Makes a `GET /timeseries.stream` HTTP request.
 
@@ -129,7 +129,7 @@ async def stream_async(
         path: Optional[str] = None,
     ) -> Bento:
         """
-        Request a historical time series stream from Databento asynchronously.
+        Request a historical time series data stream from Databento asynchronously.
 
         Makes a `GET /timeseries.stream` HTTP request.
 

examples/historical_batch.py

@@ -9,7 +9,7 @@
     key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
-    response = client.batch.timeseries_submit(
+    response = client.batch.submit_job(
         dataset="GLBX.MDP3",
         symbols=["ESH1"],
         schema="mbo",

notebooks/quickstart.ipynb

@@ -28,7 +28,7 @@
     "- Using the historical client to request time series market data\n",
     "- Working with Bento data I/O helper objects\n",
     "- Using the historical client to make batch data requests\n",
-    "- Querying batch data job states\n",
+    "- Querying batch job states\n",
     "\n",
     "**Tip:** You can call help() on any class or method to see the 'docstring.'"
    ]
@@ -1416,7 +1416,7 @@
     }
    ],
    "source": [
-    "client.batch.timeseries_submit(\n",
+    "client.batch.submit_job(\n",
     "    dataset=\"GLBX.MDP3\",\n",
     "    symbols=[\"ESH1\"],\n",
     "    schema=\"trades\",\n",
@@ -1434,7 +1434,7 @@
    "id": "ec29b7b2-612a-4bbe-bd70-460b08e3866e",
    "metadata": {},
    "source": [
-    "## Querying batch data job state\n",
+    "## Querying batch job state\n",
     "\n",
     "It's possible to query for a list of your batch jobs, with optional filter parameters for `state` and `since`. This could help to programatically build and manage larger data pipelines."
    ]

tests/test_historical_batch.py

@@ -10,10 +10,10 @@ def setup(self) -> None:
         key = "DUMMY_API_KEY"
         self.client = db.Historical(key=key)
 
-    def test_batch_timeseries_submit_given_invalid_schema_raises_error(self) -> None:
+    def test_batch_submit_job_given_invalid_schema_raises_error(self) -> None:
         # Arrange, Act, Assert
         with pytest.raises(ValueError):
-            self.client.batch.timeseries_submit(
+            self.client.batch.submit_job(
                 dataset="GLBX.MDP3",
                 symbols=["ES"],
                 schema="ticks",  # <--- invalid
@@ -22,10 +22,10 @@ def test_batch_timeseries_submit_given_invalid_schema_raises_error(self) -> None
                 encoding="csv",
             )
 
-    def test_batch_timeseries_submit_given_invalid_encoding_raises_error(self) -> None:
+    def test_batch_submit_job_given_invalid_encoding_raises_error(self) -> None:
         # Arrange, Act, Assert
         with pytest.raises(ValueError):
-            self.client.batch.timeseries_submit(
+            self.client.batch.submit_job(
                 dataset="GLBX.MDP3",
                 symbols=["ES"],
                 schema="mbo",
@@ -34,10 +34,10 @@ def test_batch_timeseries_submit_given_invalid_encoding_raises_error(self) -> No
                 encoding="gzip",  # <--- invalid
             )
 
-    def test_batch_timeseries_submit_given_invalid_stype_in_raises_error(self) -> None:
+    def test_batch_submit_job_given_invalid_stype_in_raises_error(self) -> None:
         # Arrange, Act, Assert
         with pytest.raises(ValueError):
-            self.client.batch.timeseries_submit(
+            self.client.batch.submit_job(
                 dataset="GLBX.MDP3",
                 symbols="ESH1",
                 schema="mbo",
@@ -49,12 +49,12 @@ def test_batch_timeseries_submit_given_invalid_stype_in_raises_error(self) -> No
             )
 
     @pytest.mark.skipif(sys.version_info < (3, 8), reason="incompatible mocking")
-    def test_batch_timeseries_submit_sends_expected_request(self, mocker) -> None:
+    def test_batch_submit_job_sends_expected_request(self, mocker) -> None:
         # Arrange
         mocked_get = mocker.patch("requests.post")
 
         # Act
-        self.client.batch.timeseries_submit(
+        self.client.batch.submit_job(
             dataset="GLBX.MDP3",
             symbols="ESH1",
             schema="trades",
@@ -72,7 +72,7 @@ def test_batch_timeseries_submit_sends_expected_request(self, mocker) -> None:
         call = mocked_get.call_args.kwargs
         assert (
             call["url"]
-            == f"https://hist.databento.com/v{db.API_VERSION}/batch.timeseries_submit"
+            == f"https://hist.databento.com/v{db.API_VERSION}/batch.submit_job"
         )
         assert sorted(call["headers"].keys()) == ["accept", "user-agent"]
         assert call["headers"]["accept"] == "application/json"