hirundo 0.1.6__py3-none-any.whl → 0.1.8__py3-none-any.whl

hirundo/__init__.py

@@ -32,4 +32,4 @@ __all__ = [
     "StorageIntegration",
 ]
 
-__version__ = "0.1.6"
+__version__ = "0.1.8"

hirundo/_env.py

@@ -1,12 +1,26 @@
+import enum
 import os
+from pathlib import Path
 
 from dotenv import load_dotenv
 
-load_dotenv()
+
+class EnvLocation(enum.Enum):
+    DOTENV = Path.cwd() / ".env"
+    HOME = Path.home() / ".hirundo.conf"
+
+
+if os.path.exists(EnvLocation.DOTENV.value):
+    load_dotenv(EnvLocation.DOTENV.value)
+elif os.path.exists(EnvLocation.HOME.value):
+    load_dotenv(EnvLocation.HOME.value)
 
 API_HOST = os.getenv("API_HOST", "https://api.hirundo.io")
 API_KEY = os.getenv("API_KEY")
-if not API_KEY:
-    raise ValueError(
-        "API_KEY is not set. Please run `hirundo setup` to set the API key"
-    )
+
+
+def check_api_key():
+    if not API_KEY:
+        raise ValueError(
+            "API_KEY is not set. Please run `hirundo setup` to set the API key"
+        )

hirundo/_headers.py

@@ -1,9 +1,13 @@
-from hirundo._env import API_KEY
+from hirundo._env import API_KEY, check_api_key
 
 json_headers = {
     "Content-Type": "application/json",
     "Accept": "application/json",
 }
-auth_headers = {
-    "Authorization": f"Bearer {API_KEY}",
-}
+
+
+def get_auth_headers():
+    check_api_key()
+    return {
+        "Authorization": f"Bearer {API_KEY}",
+    }

hirundo/_http.py

@@ -0,0 +1,14 @@
+from requests import Response
+
+import hirundo.logger
+
+logger = hirundo.logger.get_logger(__name__)
+
+
+def raise_for_status_with_reason(response: Response):
+    try:
+        response.reason = response.json().get("reason", None)
+    except Exception as e:
+        logger.debug("Failed to parse response as JSON: %s", e)
+
+    response.raise_for_status()

hirundo/_iter_sse_retrying.py

@@ -1,7 +1,7 @@
 import asyncio
 import time
+import typing
 from collections.abc import AsyncGenerator, Generator
-from typing import Union
 
 import httpx
 from httpx_sse import ServerSentEvent, aconnect_sse, connect_sse
@@ -13,7 +13,7 @@ def iter_sse_retrying(
     client: httpx.Client,
     method: str,
     url: str,
-    headers: Union[dict[str, str], None] = None,
+    headers: typing.Optional[dict[str, str]] = None,
 ) -> Generator[ServerSentEvent, None, None]:
     if headers is None:
         headers = {}

hirundo/cli.py

@@ -1,11 +1,14 @@
+import os
 import re
 import sys
+import typing
+from pathlib import Path
 from typing import Annotated
 from urllib.parse import urlparse
 
 import typer
 
-from hirundo._env import API_HOST
+from hirundo._env import API_HOST, EnvLocation
 
 docs = "sphinx" in sys.modules
 hirundo_epilog = (
@@ -14,12 +17,18 @@ hirundo_epilog = (
     else "Made with ❤️ by Hirundo. Visit https://www.hirundo.io for more information."
 )
 
+
 app = typer.Typer(
-    name="hirundo", no_args_is_help=True, rich_markup_mode="rich", epilog=hirundo_epilog
+    name="hirundo",
+    no_args_is_help=True,
+    rich_markup_mode="rich",
+    epilog=hirundo_epilog,
 )
 
 
-def upsert_env(var_name: str, var_value: str):
+def _upsert_env(
+    dotenv_filepath: typing.Union[str, Path], var_name: str, var_value: str
+):
     """
     Change an environment variable in the .env file.
     If the variable does not exist, it will be added.
@@ -28,18 +37,30 @@ def upsert_env(var_name: str, var_value: str):
         var_name: The name of the environment variable to change.
         var_value: The new value of the environment variable.
     """
-    dotenv = "./.env"
     regex = re.compile(rf"^{var_name}=.*$")
-    with open(dotenv) as f:
-        lines = f.readlines()
+    lines = []
+    if os.path.exists(dotenv_filepath):
+        with open(dotenv_filepath) as f:
+            lines = f.readlines()
 
-    with open(dotenv, "w") as f:
+    with open(dotenv_filepath, "w") as f:
         f.writelines(line for line in lines if not regex.search(line) and line != "\n")
 
-    with open(dotenv, "a") as f:
+    with open(dotenv_filepath, "a") as f:
         f.writelines(f"\n{var_name}={var_value}")
 
 
+def upsert_env(var_name: str, var_value: str):
+    if os.path.exists(EnvLocation.DOTENV.value):
+        # If a `.env` file exists, re-use it
+        _upsert_env(EnvLocation.DOTENV.value, var_name, var_value)
+        return EnvLocation.DOTENV.name
+    else:
+        # Create a `.hirundo.conf` file with environment variables in the home directory
+        _upsert_env(EnvLocation.HOME.value, var_name, var_value)
+        return EnvLocation.HOME.name
+
+
 def fix_api_host(api_host: str):
     if not api_host.startswith("http") and not api_host.startswith("https"):
         api_host = f"https://{api_host}"
@@ -68,8 +89,15 @@ def setup_api_key(
     Setup the API key for the Hirundo client library.
     Values are saved to a .env file in the current directory for use by the library in requests.
     """
-    upsert_env("API_KEY", api_key)
-    print("API key saved to .env for future use. Please do not share the .env file")
+    saved_to = upsert_env("API_KEY", api_key)
+    if saved_to == EnvLocation.HOME.name:
+        print(
+            "API key saved to ~/.hirundo.conf for future use. Please do not share the ~/.hirundo.conf file since it contains your secret API key."
+        )
+    elif saved_to == EnvLocation.DOTENV.name:
+        print(
+            "API key saved to local .env file for future use. Please do not share the .env file since it contains your secret API key."
+        )
 
 
 @app.command("change-remote", epilog=hirundo_epilog)
@@ -90,8 +118,13 @@ def change_api_remote(
     """
     api_host = fix_api_host(api_host)
 
-    upsert_env("API_HOST", api_host)
-    print("API host saved to .env for future use. Please do not share this file")
+    saved_to = upsert_env("API_HOST", api_host)
+    if saved_to == EnvLocation.HOME.name:
+        print(
+            "API host saved to ~/.hirundo.conf for future use. Please do not share the ~/.hirundo.conf file"
+        )
+    elif saved_to == EnvLocation.DOTENV.name:
+        print("API host saved to .env for future use. Please do not share this file")
 
 
 @app.command("setup", epilog=hirundo_epilog)
@@ -119,11 +152,41 @@ def setup(
     Setup the Hirundo client library.
     """
     api_host = fix_api_host(api_host)
-    upsert_env("API_HOST", api_host)
-    upsert_env("API_KEY", api_key)
-    print(
-        "API host and API key saved to .env for future use. Please do not share this file"
-    )
+    api_host_saved_to = upsert_env("API_HOST", api_host)
+    api_key_saved_to = upsert_env("API_KEY", api_key)
+    if api_host_saved_to != api_key_saved_to:
+        print(
+            "API host and API key saved to different locations. This should not happen. Please report this issue."
+        )
+        if (
+            api_host_saved_to == EnvLocation.HOME.name
+            and api_key_saved_to == EnvLocation.DOTENV.name
+        ):
+            print(
+                "API host saved to ~/.hirundo.conf for future use. Please do not share the ~/.hirundo.conf file"
+            )
+            print(
+                "API key saved to local .env file for future use. Please do not share the .env file since it contains your secret API key."
+            )
+        elif (
+            api_host_saved_to == EnvLocation.DOTENV.name
+            and api_key_saved_to == EnvLocation.HOME.name
+        ):
+            print(
+                "API host saved to .env for future use. Please do not share this file"
+            )
+            print(
+                "API key saved to ~/.hirundo.conf for future use. Please do not share the ~/.hirundo.conf file since it contains your secret API key."
+            )
+        return
+    if api_host_saved_to == EnvLocation.HOME.name:
+        print(
+            "API host and API key saved to ~/.hirundo.conf for future use. Please do not share the ~/.hirundo.conf file since it contains your secret API key."
+        )
+    elif api_host_saved_to == EnvLocation.DOTENV.name:
+        print(
+            "API host and API key saved to .env for future use. Please do not share this file since it contains your secret API key."
+        )
 
 
 typer_click_object = typer.main.get_command(app)