MOD: Rename Access Key -> API Key across docs

cjdsellers · cjdsellers · commit 33d9cd4791bb · 2022-08-22T07:05:24.000Z
diff --git a/README.md b/README.md
@@ -42,17 +42,17 @@ To install the latest stable version of the package from PyPI:
     pip install -U databento
 
 ## Usage
-The library needs to be configured with an access key from your account.
+The library needs to be configured with an API key from your account.
 [Sign up](https://databento.com/signup) for free and you will automatically
-receive a set of access keys to start with. Each access key is a 28-character
-string that can be found on the Access Keys page of your [Databento user portal](https://databento.com/platform/keys).
+receive a set of API keys to start with. Each API key is a 28-character
+string that can be found on the API Keys page of your [Databento user portal](https://databento.com/platform/keys).
 
 A simple Databento application looks like this:
 
 ```python
 import databento as db
 
-client = db.Historical('YOUR_ACCESS_KEY')
+client = db.Historical('YOUR_API_KEY')
 data = client.timeseries.stream(
     dataset='GLBX.MDP3',
     start='2020-11-02T14:30',
@@ -61,7 +61,7 @@ data = client.timeseries.stream(
 data.replay(callback=print)    # market replay, with `print` as event handler
 ```
 
-Replace `YOUR_ACCESS_KEY` with an actual access key, then run this program.
+Replace `YOUR_API_KEY` with an actual API key, then run this program.
 
 This uses `.replay()` to access the entire block of data
 and dispatch each data event to an event handler. You can also use
@@ -72,15 +72,15 @@ df = data.to_df(pretty_ts=True, pretty_px=True)  # to DataFrame, with pretty for
 array = data.to_ndarray()                        # to ndarray
 ```
 
-Note that the access key was also passed as a parameter, which is
-[not recommended for production applications](https://docs0.databento.com/knowledge-base/new-users/securing-your-access-keys?historical=python&live=python).
-Instead, you can leave out this parameter to pass your access key via the `DATABENTO_ACCESS_KEY` environment variable:
+Note that the API key was also passed as a parameter, which is
+[not recommended for production applications](https://docs0.databento.com/knowledge-base/new-users/securing-your-api-keys?historical=python&live=python).
+Instead, you can leave out this parameter to pass your API key via the `DATABENTO_API_KEY` environment variable:
 
 ```python
 import databento as db
 
-client = db.Historical('YOUR_ACCESS_KEY')   # pass as parameter
-client = db.Historical()                    # pass as `DATABENTO_ACCESS_KEY` environment variable
+client = db.Historical('YOUR_API_KEY')  # pass as parameter
+client = db.Historical()                # pass as `DATABENTO_API_KEY` environment variable
 ```
 
 ## License
diff --git a/databento/historical/client.py b/databento/historical/client.py
@@ -19,16 +19,16 @@ class Historical:
     Parameters
     ----------
     key : str, optional
-        The API user access key for authentication.
-        If ``None`` then the `DATABENTO_ACCESS_KEY` environment variable is used.
+        The user API key for authentication.
+        If ``None`` then the `DATABENTO_API_KEY` environment variable is used.
     gateway : HistoricalGateway or str, default HistoricalGateway.NEAREST
         The API server gateway.
         If ``None`` then the default gateway is used.
 
     Examples
     --------
     > import databento as db
-    > client = db.Historical('YOUR_ACCESS_KEY')
+    > client = db.Historical('YOUR_API_KEY')
     """
 
     def __init__(
@@ -37,9 +37,9 @@ def __init__(
         gateway: Union[HistoricalGateway, str] = HistoricalGateway.NEAREST,
     ):
         if key is None:
-            key = os.environ.get("DATABENTO_ACCESS_KEY")
+            key = os.environ.get("DATABENTO_API_KEY")
         if key is None or not isinstance(key, str) or key.isspace():
-            raise ValueError(f"invalid API access key, was {key}")
+            raise ValueError(f"invalid API key, was {key}")
 
         # Configure data access gateway
         gateway = enum_or_str_lowercase(gateway, "gateway")
@@ -60,7 +60,7 @@ def __init__(
     @property
     def key(self) -> str:
         """
-        Return the API user access key for the client.
+        Return the user API key for the client.
 
         Returns
         -------
diff --git a/databento/historical/http.py b/databento/historical/http.py
@@ -78,11 +78,11 @@ def _create_bento(path: str) -> Union[MemoryBento, FileBento]:
         else:
             return FileBento(path=path)
 
-    def _check_access_key(self):
-        if self._key == "YOUR_ACCESS_KEY":
+    def _check_api_key(self):
+        if self._key == "YOUR_API_KEY":
             raise ValueError(
-                "The access key is currently set to 'YOUR_ACCESS_KEY'. "
-                "Please replace this value with a valid access key. "
+                "The API key is currently set to 'YOUR_API_KEY'. "
+                "Please replace this value with a valid API key. "
                 "You can find these through your Databento user portal.",
             )
 
@@ -92,7 +92,7 @@ def _get(
         params: Optional[List[Tuple[str, str]]] = None,
         basic_auth: bool = False,
     ) -> Response:
-        self._check_access_key()
+        self._check_api_key()
 
         with requests.get(
             url=url,
@@ -112,7 +112,7 @@ async def _get_async(
         params: Optional[List[Tuple[str, str]]] = None,
         basic_auth: bool = False,
     ) -> ClientResponse:
-        self._check_access_key()
+        self._check_api_key()
         async with aiohttp.ClientSession() as session:
             async with session.get(
                 url=url,
@@ -132,7 +132,7 @@ def _post(
         params: Optional[List[Tuple[str, str]]] = None,
         basic_auth: bool = False,
     ) -> Response:
-        self._check_access_key()
+        self._check_api_key()
 
         with requests.post(
             url=url,
@@ -153,7 +153,7 @@ def _stream(
         basic_auth: bool,
         bento: Bento,
     ) -> None:
-        self._check_access_key()
+        self._check_api_key()
 
         with requests.get(
             url=url,
@@ -189,7 +189,7 @@ async def _stream_async(
         basic_auth: bool,
         bento: Bento,
     ) -> None:
-        self._check_access_key()
+        self._check_api_key()
 
         async with aiohttp.ClientSession() as session:
             async with session.get(
diff --git a/examples/historical_batch.py b/examples/historical_batch.py
@@ -6,7 +6,7 @@
 if __name__ == "__main__":
     db.log = "debug"  # optional debug logging
 
-    key = "YOUR_ACCESS_KEY"
+    key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     response = client.batch.timeseries_submit(
diff --git a/examples/historical_metadata.py b/examples/historical_metadata.py
@@ -4,7 +4,7 @@
 if __name__ == "__main__":
     db.log = "debug"  # optional debug logging
 
-    key = "YOUR_ACCESS_KEY"
+    key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     print(client.metadata.list_publishers())
diff --git a/examples/historical_metadata_get_billable_size.py b/examples/historical_metadata_get_billable_size.py
@@ -4,7 +4,7 @@
 if __name__ == "__main__":
     db.log = "debug"  # optional debug logging
 
-    key = "YOUR_ACCESS_KEY"
+    key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     size: int = client.metadata.get_billable_size(
diff --git a/examples/historical_metadata_get_cost.py b/examples/historical_metadata_get_cost.py
@@ -4,7 +4,7 @@
 if __name__ == "__main__":
     db.log = "debug"  # optional debug logging
 
-    key = "YOUR_ACCESS_KEY"
+    key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     cost1: float = client.metadata.get_cost(
diff --git a/examples/historical_metadata_get_shape.py b/examples/historical_metadata_get_shape.py
@@ -6,7 +6,7 @@
 if __name__ == "__main__":
     db.log = "debug"  # optional debug logging
 
-    key = "YOUR_ACCESS_KEY"
+    key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     shape: Tuple = client.metadata.get_shape(
diff --git a/examples/historical_metadata_list_unit_price.py b/examples/historical_metadata_list_unit_price.py
@@ -6,7 +6,7 @@
 if __name__ == "__main__":
     db.log = "debug"  # optional debug logging
 
-    key = "YOUR_ACCESS_KEY"
+    key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     unit_prices = client.metadata.list_unit_prices(
diff --git a/examples/historical_symbology_resolve.py b/examples/historical_symbology_resolve.py
@@ -7,7 +7,7 @@
 if __name__ == "__main__":
     db.log = "debug"  # optional debug logging
 
-    key = "YOUR_ACCESS_KEY"
+    key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     response = client.symbology.resolve(
diff --git a/examples/historical_timeseries_async.py b/examples/historical_timeseries_async.py
@@ -8,7 +8,7 @@
 async def request_stream_async():
     db.log = "debug"  # optional debug logging
 
-    key = "YOUR_ACCESS_KEY"
+    key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     data: Bento = await client.timeseries.stream_async(
diff --git a/examples/historical_timeseries_disk_io.py b/examples/historical_timeseries_disk_io.py
@@ -7,7 +7,7 @@
 if __name__ == "__main__":
     db.log = "debug"  # optional debug logging
 
-    key = "YOUR_ACCESS_KEY"
+    key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     path = "my_data.dbz"
diff --git a/examples/historical_timeseries_replay.py b/examples/historical_timeseries_replay.py
@@ -5,7 +5,7 @@
 if __name__ == "__main__":
     db.log = "debug"  # optional debug logging
 
-    key = "YOUR_ACCESS_KEY"
+    key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     data: Bento = client.timeseries.stream(
diff --git a/examples/historical_timeseries_to_df.py b/examples/historical_timeseries_to_df.py
@@ -7,7 +7,7 @@
 if __name__ == "__main__":
     db.log = "debug"  # optional debug logging
 
-    key = "YOUR_ACCESS_KEY"
+    key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     data: Bento = client.timeseries.stream(
diff --git a/examples/historical_timeseries_to_file.py b/examples/historical_timeseries_to_file.py
@@ -7,7 +7,7 @@
 if __name__ == "__main__":
     db.log = "debug"  # optional debug logging
 
-    key = "YOUR_ACCESS_KEY"
+    key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     data: Bento = client.timeseries.stream(
diff --git a/examples/historical_timeseries_to_list_glbx.py b/examples/historical_timeseries_to_list_glbx.py
@@ -7,7 +7,7 @@
 if __name__ == "__main__":
     db.log = "debug"  # optional debug logging
 
-    key = "YOUR_ACCESS_KEY"
+    key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     data: Bento = client.timeseries.stream(
diff --git a/examples/historical_timeseries_to_list_xnas.py b/examples/historical_timeseries_to_list_xnas.py
@@ -7,7 +7,7 @@
 if __name__ == "__main__":
     db.log = "debug"  # optional debug logging
 
-    key = "YOUR_ACCESS_KEY"
+    key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     data: Bento = client.timeseries.stream(
diff --git a/notebooks/quickstart.ipynb b/notebooks/quickstart.ipynb
@@ -61,7 +61,7 @@
     "\n",
     "Once you've installed the Python client library, you can import it and initialize a historical client for requests. We'll use this `client` throughout the rest of the tutorial.\n",
     "\n",
-    "To initialize a client, you need to provide a valid API access key. You can find these on the Access Keys page of your Databento portal at https://databento.com."
+    "To initialize a client, you need to provide a valid API key. You can find these on the API Keys page of your Databento portal at https://databento.com."
    ]
   },
   {
@@ -81,7 +81,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "client = db.Historical(key=\"YOUR_ACCESS_KEY\")"
+    "client = db.Historical(key=\"YOUR_API_KEY\")"
    ]
   },
   {
diff --git a/tests/data/generator.py b/tests/data/generator.py
@@ -4,7 +4,7 @@
 
 
 if __name__ == "__main__":
-    key = ""  # <-- Change to valid access key prior to running
+    key = ""  # <-- Change to valid API key prior to running
     client = db.Historical(key=key)
 
     for schema in Schema:
diff --git a/tests/test_historical_batch.py b/tests/test_historical_batch.py
@@ -7,7 +7,7 @@
 
 class TestHistoricalBatch:
     def setup(self) -> None:
-        key = "DUMMY_ACCESS_KEY"
+        key = "DUMMY_API_KEY"
         self.client = db.Historical(key=key)
 
     def test_batch_timeseries_submit_given_invalid_schema_raises_error(self) -> None:
diff --git a/tests/test_historical_client.py b/tests/test_historical_client.py
@@ -11,17 +11,17 @@
 class TestHistoricalClient:
     def test_key_returns_expected(self) -> None:
         # Arrange
-        key = "DUMMY_ACCESS_KEY"
+        key = "DUMMY_API_KEY"
 
         # Act
         client = db.Historical(key=key)
 
         # Assert
-        assert client.key == "DUMMY_ACCESS_KEY"
+        assert client.key == "DUMMY_API_KEY"
 
     def test_default_host_returns_expected(self) -> None:
         # Arrange, Act
-        self.client = db.Historical(key="DUMMY_ACCESS_KEY")
+        self.client = db.Historical(key="DUMMY_API_KEY")
 
         # Assert
         assert self.client.gateway == "https://hist.databento.com"
@@ -41,7 +41,7 @@ def test_gateway_nearest_and_bo1_map_to_hist_databento(
         expected,
     ):
         # Arrange, Act
-        client = db.Historical(key="DUMMY_ACCESS_KEY", gateway=gateway)
+        client = db.Historical(key="DUMMY_API_KEY", gateway=gateway)
 
         # Assert
         assert client.gateway == expected
@@ -51,7 +51,7 @@ def test_custom_gateway_returns_expected(self):
         ny4_gateway = "ny4.databento.com"
 
         # Act
-        client = db.Historical(key="DUMMY_ACCESS_KEY", gateway=ny4_gateway)
+        client = db.Historical(key="DUMMY_API_KEY", gateway=ny4_gateway)
 
         # Assert
         assert client.gateway == ny4_gateway
@@ -64,7 +64,7 @@ def test_re_request_symbology_makes_expected_request(self, mocker) -> None:
         test_data_path = get_test_data_path(schema=Schema.MBO)
         data = FileBento(path=test_data_path)
 
-        client = Historical(key="DUMMY_ACCESS_KEY")
+        client = Historical(key="DUMMY_API_KEY")
 
         # Act
         client.request_symbology(data)
@@ -100,7 +100,7 @@ def test_request_full_definitions_expected_request(self, mocker) -> None:
         test_data_path = get_test_data_path(schema=Schema.MBO)
         data = FileBento(path=test_data_path)
 
-        client = Historical(key="DUMMY_ACCESS_KEY")
+        client = Historical(key="DUMMY_API_KEY")
 
         # Act
         client.request_full_definitions(data)
diff --git a/tests/test_historical_metadata.py b/tests/test_historical_metadata.py
@@ -8,7 +8,7 @@
 
 class TestHistoricalMetadata:
     def setup(self) -> None:
-        key = "DUMMY_ACCESS_KEY"
+        key = "DUMMY_API_KEY"
         self.client = db.Historical(key=key)
 
     @pytest.mark.skipif(sys.version_info < (3, 8), reason="incompatible mocking")
diff --git a/tests/test_historical_timeseries.py b/tests/test_historical_timeseries.py
@@ -7,7 +7,7 @@
 
 class TestHistoricalTimeSeries:
     def setup(self) -> None:
-        key = "DUMMY_ACCESS_KEY"
+        key = "DUMMY_API_KEY"
         self.client = db.Historical(key=key)
 
     def test_stream_given_invalid_schema_raises_error(self) -> None:
