apitally 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

apitally/__init__.py

@@ -1 +1 @@
-__version__ = "0.3.0"
+__version__ = "0.3.2"

apitally/client/asyncio.py

@@ -16,14 +16,16 @@ from apitally.client.base import (
     ApitallyClientBase,
     ApitallyKeyCacheBase,
 )
+from apitally.client.logging import get_logger
 
 
-logger = logging.getLogger(__name__)
+logger = get_logger(__name__)
 retry = partial(
     backoff.on_exception,
     backoff.expo,
     httpx.HTTPError,
     max_tries=3,
+    logger=logger,
     giveup_log_level=logging.WARNING,
 )
 
@@ -74,6 +76,13 @@ class ApitallyClient(ApitallyClientBase):
     def stop_sync_loop(self) -> None:
         self._stop_sync_loop = True
 
+    async def handle_shutdown(self) -> None:
+        if self._sync_loop_task is not None:
+            self._sync_loop_task.cancel()
+        # Send any remaining requests data before exiting
+        async with self.get_http_client() as client:
+            await self.send_requests_data(client)
+
     def set_app_info(self, app_info: Dict[str, Any]) -> None:
         self._app_info_sent = False
         self._app_info_payload = self.get_info_payload(app_info)
@@ -109,7 +118,7 @@ class ApitallyClient(ApitallyClientBase):
             self.handle_keys_response(response_data)
             self._keys_updated_at = time.time()
         elif self.key_registry.salt is None:  # pragma: no cover
-            logger.error("Initial Apitally API key sync failed")
+            logger.critical("Initial Apitally API key sync failed")
             # Exit because the application will not be able to authenticate requests
             sys.exit(1)
         elif (self._keys_updated_at is not None and time.time() - self._keys_updated_at > MAX_QUEUE_TIME) or (
@@ -119,6 +128,7 @@ class ApitallyClient(ApitallyClientBase):
 
     @retry(raise_on_giveup=False)
     async def _send_app_info(self, client: httpx.AsyncClient, payload: Dict[str, Any]) -> None:
+        logger.debug("Sending app info")
         response = await client.post(url="/info", json=payload, timeout=REQUEST_TIMEOUT)
         if response.status_code == 404 and "Client ID" in response.text:
             self.stop_sync_loop()
@@ -130,11 +140,13 @@ class ApitallyClient(ApitallyClientBase):
 
     @retry()
     async def _send_requests_data(self, client: httpx.AsyncClient, payload: Dict[str, Any]) -> None:
+        logger.debug("Sending requests data")
         response = await client.post(url="/requests", json=payload)
         response.raise_for_status()
 
     @retry(raise_on_giveup=False)
     async def _get_keys(self, client: httpx.AsyncClient) -> Dict[str, Any]:
+        logger.debug("Updating API keys")
         response = await client.get(url="/keys")
         response.raise_for_status()
         return response.json()

apitally/client/base.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import json
-import logging
 import os
 import re
 import threading
@@ -15,8 +14,10 @@ from math import floor
 from typing import Any, Dict, List, Optional, Tuple, Type, TypeVar, Union, cast
 from uuid import UUID, uuid4
 
+from apitally.client.logging import get_logger
 
-logger = logging.getLogger(__name__)
+
+logger = get_logger(__name__)
 
 HUB_BASE_URL = os.getenv("APITALLY_HUB_BASE_URL") or "https://hub.apitally.io"
 HUB_VERSION = "v1"

apitally/client/logging.py

@@ -0,0 +1,17 @@
+import logging
+import os
+
+
+debug = os.getenv("APITALLY_DEBUG", "false").lower() in {"true", "yes", "y", "1"}
+root_logger = logging.getLogger("apitally")
+
+if debug:
+    root_logger.setLevel(logging.DEBUG)
+    console_handler = logging.StreamHandler()
+    formatter = logging.Formatter("%(asctime)s [%(name)s] %(levelname)s: %(message)s")
+    console_handler.setFormatter(formatter)
+    root_logger.addHandler(console_handler)
+
+
+def get_logger(name: str) -> logging.Logger:
+    return logging.getLogger(name)

apitally/client/threading.py

@@ -17,14 +17,16 @@ from apitally.client.base import (
     ApitallyClientBase,
     ApitallyKeyCacheBase,
 )
+from apitally.client.logging import get_logger
 
 
-logger = logging.getLogger(__name__)
+logger = get_logger(__name__)
 retry = partial(
     backoff.on_exception,
     backoff.expo,
     requests.RequestException,
     max_tries=3,
+    logger=logger,
     giveup_log_level=logging.WARNING,
 )
 
@@ -68,24 +70,31 @@ class ApitallyClient(ApitallyClientBase):
     def start_sync_loop(self) -> None:
         self._stop_sync_loop.clear()
         if self._thread is None or not self._thread.is_alive():
-            self._thread = Thread(target=self._run_sync_loop)
+            self._thread = Thread(target=self._run_sync_loop, daemon=True)
             self._thread.start()
             register_exit(self.stop_sync_loop)
 
     def _run_sync_loop(self) -> None:
-        first_iteration = True
-        while not self._stop_sync_loop.is_set():
-            try:
-                with requests.Session() as session:
-                    if self.sync_api_keys:
-                        self.get_keys(session)
-                    if not self._app_info_sent and not first_iteration:
-                        self.send_app_info(session)
-                    self.send_requests_data(session)
-                time.sleep(self.sync_interval)
-            except Exception as e:  # pragma: no cover
-                logger.exception(e)
-            first_iteration = False
+        try:
+            last_sync_time = 0.0
+            while not self._stop_sync_loop.is_set():
+                try:
+                    now = time.time()
+                    if (now - last_sync_time) > self.sync_interval:
+                        with requests.Session() as session:
+                            if self.sync_api_keys:
+                                self.get_keys(session)
+                            if not self._app_info_sent and last_sync_time > 0:  # not on first sync
+                                self.send_app_info(session)
+                            self.send_requests_data(session)
+                        last_sync_time = now
+                    time.sleep(1)
+                except Exception as e:  # pragma: no cover
+                    logger.exception(e)
+        finally:
+            # Send any remaining requests data before exiting
+            with requests.Session() as session:
+                self.send_requests_data(session)
 
     def stop_sync_loop(self) -> None:
         self._stop_sync_loop.set()
@@ -125,7 +134,7 @@ class ApitallyClient(ApitallyClientBase):
             self.handle_keys_response(response_data)
             self._keys_updated_at = time.time()
         elif self.key_registry.salt is None:  # pragma: no cover
-            logger.error("Initial Apitally API key sync failed")
+            logger.critical("Initial Apitally API key sync failed")
             # Exit because the application will not be able to authenticate requests
             sys.exit(1)
         elif (self._keys_updated_at is not None and time.time() - self._keys_updated_at > MAX_QUEUE_TIME) or (
@@ -135,6 +144,7 @@ class ApitallyClient(ApitallyClientBase):
 
     @retry(raise_on_giveup=False)
     def _send_app_info(self, session: requests.Session, payload: Dict[str, Any]) -> None:
+        logger.debug("Sending app info")
         response = session.post(url=f"{self.hub_url}/info", json=payload, timeout=REQUEST_TIMEOUT)
         if response.status_code == 404 and "Client ID" in response.text:
             self.stop_sync_loop()
@@ -146,11 +156,13 @@ class ApitallyClient(ApitallyClientBase):
 
     @retry()
     def _send_requests_data(self, session: requests.Session, payload: Dict[str, Any]) -> None:
+        logger.debug("Sending requests data")
         response = session.post(url=f"{self.hub_url}/requests", json=payload, timeout=REQUEST_TIMEOUT)
         response.raise_for_status()
 
     @retry(raise_on_giveup=False)
     def _get_keys(self, session: requests.Session) -> Dict[str, Any]:
+        logger.debug("Updating API keys")
         response = session.get(url=f"{self.hub_url}/keys", timeout=REQUEST_TIMEOUT)
         response.raise_for_status()
         return response.json()

apitally/starlette.py

@@ -5,7 +5,17 @@ import json
 import sys
 import time
 from importlib.metadata import PackageNotFoundError, version
-from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Tuple, Type
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Callable,
+    Dict,
+    List,
+    Optional,
+    Tuple,
+    Type,
+    Union,
+)
 
 from httpx import HTTPStatusError
 from starlette.authentication import (
@@ -59,6 +69,7 @@ class ApitallyMiddleware(BaseHTTPMiddleware):
         )
         self.client.start_sync_loop()
         self.delayed_set_app_info(app_version, openapi_url)
+        _register_shutdown_handler(app, self.client.handle_shutdown)
         super().__init__(app)
 
     def delayed_set_app_info(self, app_version: Optional[str] = None, openapi_url: Optional[str] = None) -> None:
@@ -221,7 +232,7 @@ def _get_endpoint_info(app: ASGIApp) -> List[EndpointInfo]:
     return schemas.get_endpoints(routes)
 
 
-def _get_routes(app: ASGIApp) -> List[BaseRoute]:
+def _get_routes(app: Union[ASGIApp, Router]) -> List[BaseRoute]:
     if isinstance(app, Router):
         return app.routes
     elif hasattr(app, "app"):
@@ -229,6 +240,13 @@ def _get_routes(app: ASGIApp) -> List[BaseRoute]:
     return []  # pragma: no cover
 
 
+def _register_shutdown_handler(app: Union[ASGIApp, Router], shutdown_handler: Callable[[], Any]) -> None:
+    if isinstance(app, Router):
+        app.add_event_handler("shutdown", shutdown_handler)
+    elif hasattr(app, "app"):
+        _register_shutdown_handler(app.app, shutdown_handler)
+
+
 def _get_versions(app_version: Optional[str]) -> Dict[str, str]:
     versions = {
         "python": f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}",

{apitally-0.3.0.dist-info → apitally-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: apitally
-Version: 0.3.0
+Version: 0.3.2
 Summary: Apitally client library for Python
 Home-page: https://docs.apitally.io
 License: MIT
@@ -30,7 +30,7 @@ Requires-Dist: fastapi (>=0.87.0) ; extra == "fastapi"
 Requires-Dist: flask (>=2.0.0) ; extra == "flask"
 Requires-Dist: httpx (>=0.22.0) ; extra == "fastapi" or extra == "starlette"
 Requires-Dist: requests (>=2.26.0) ; extra == "django-rest-framework" or extra == "django-ninja" or extra == "flask"
-Requires-Dist: starlette (>=0.21.0) ; extra == "fastapi" or extra == "starlette"
+Requires-Dist: starlette (>=0.21.0,<1.0.0) ; extra == "fastapi" or extra == "starlette"
 Project-URL: Documentation, https://docs.apitally.io
 Project-URL: Repository, https://github.com/apitally/python-client
 Description-Content-Type: text/markdown
@@ -45,7 +45,7 @@ Description-Content-Type: text/markdown
 
 <p align="center"><b>Your refreshingly simple REST API companion.</b></p>
 
-<p align="center"><i>Apitally offers API traffic monitoring and integrated API key management that is extremely easy to set up and use with new and existing API projects. No assumptions made about your infrastructure, no extra tools for you to host and maintain.</i></p>
+<p align="center"><i>Apitally offers busy engineering teams a simple and affordable API monitoring and API key management solution that is easy to set up and use with new and existing API projects.</i></p>
 
 <p align="center">🔗 <b><a href="https://apitally.io" target="_blank">apitally.io</a></b></p>
 
@@ -53,13 +53,13 @@ Description-Content-Type: text/markdown
 
 ---
 
-# Apitally client for Python
+# Apitally client library for Python
 
 [![Tests](https://github.com/apitally/python-client/actions/workflows/tests.yaml/badge.svg?event=push)](https://github.com/apitally/python-client/actions)
 [![Codecov](https://codecov.io/gh/apitally/python-client/graph/badge.svg?token=UNLYBY4Y3V)](https://codecov.io/gh/apitally/python-client)
 [![PyPI](https://img.shields.io/pypi/v/apitally?logo=pypi&logoColor=white&color=%23006dad)](https://pypi.org/project/apitally/)
 
-This client library currently supports the following frameworks:
+This client library for Apitally currently supports the following Python web frameworks:
 
 - [FastAPI](https://docs.apitally.io/frameworks/fastapi)
 - [Starlette](https://docs.apitally.io/frameworks/starlette)
@@ -67,6 +67,14 @@ This client library currently supports the following frameworks:
 - [Django Ninja](https://docs.apitally.io/frameworks/django-ninja)
 - [Django REST Framework](https://docs.apitally.io/frameworks/django-rest-framework)
 
+Learn more about Apitally on our 🌎 [website](https://apitally.io) or check out the 📚 [documentation](https://docs.apitally.io).
+
+## Key features
+
+- Middleware for different frameworks to capture metadata about API endpoints, requests and responses (no sensitive data is captured)
+- Non-blocking clients that aggregate and send captured data to Apitally and optionally synchronize API key hashes in 1 minute intervals
+- Functions to easily secure endpoints with API key authentication and permission checks
+
 ## Install
 
 Use `pip` to install and provide your framework of choice as an extra, for example:
@@ -79,10 +87,12 @@ The available extras are: `fastapi`, `starlette`, `flask`, `django_ninja` and `d
 
 ## Usage
 
-Below are basic usage examples for each supported framework. For further instructions and examples, including how to identify consumers and use API key authentication, check out our [documentation](https://docs.apitally.io/).
+Our [setup guides](https://docs.apitally.io/quickstart) include all the details you need to get started.
 
 ### FastAPI
 
+This is an example of how to add the Apitally middleware to a FastAPI application. For further instructions, see our [setup guide for FastAPI](https://docs.apitally.io/frameworks/fastapi).
+
 ```python
 from fastapi import FastAPI
 from apitally.fastapi import ApitallyMiddleware
@@ -97,6 +107,8 @@ app.add_middleware(
 
 ### Starlette
 
+This is an example of how to add the Apitally middleware to a Starlette application. For further instructions, see our [setup guide for Starlette](https://docs.apitally.io/frameworks/starlette).
+
 ```python
 from starlette.applications import Starlette
 from apitally.starlette import ApitallyMiddleware
@@ -111,6 +123,8 @@ app.add_middleware(
 
 ### Flask
 
+This is an example of how to add the Apitally middleware to a Flask application. For further instructions, see our [setup guide for Flask](https://docs.apitally.io/frameworks/flask).
+
 ```python
 from flask import Flask
 from apitally.flask import ApitallyMiddleware
@@ -125,6 +139,8 @@ app.wsgi_app = ApitallyMiddleware(
 
 ### Django Ninja
 
+This is an example of how to add the Apitally middleware to a Django Ninja application. For further instructions, see our [setup guide for Django Ninja](https://docs.apitally.io/frameworks/django-ninja).
+
 In your Django `settings.py` file:
 
 ```python
@@ -140,6 +156,8 @@ APITALLY_MIDDLEWARE = {
 
 ### Django REST Framework
 
+This is an example of how to add the Apitally middleware to a Django REST Framework application. For further instructions, see our [setup guide for Django REST Framework](https://docs.apitally.io/frameworks/django-rest-framework).
+
 In your Django `settings.py` file:
 
 ```python
@@ -155,7 +173,7 @@ APITALLY_MIDDLEWARE = {
 
 ## Getting help
 
-If you need help please join our [Apitally community on Slack](https://apitally-community.slack.com/) or [create a new discussion](https://github.com/orgs/apitally/discussions/categories/q-a) on GitHub.
+If you need help please [create a new discussion](https://github.com/orgs/apitally/discussions/categories/q-a) on GitHub.
 
 ## License
 

apitally-0.3.2.dist-info/RECORD

@@ -0,0 +1,17 @@
+apitally/__init__.py,sha256=vNiWJ14r_cw5t_7UDqDQIVZvladKFGyHH2avsLpN7Vg,22
+apitally/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+apitally/client/asyncio.py,sha256=uq1mK3LHSxhpvMY6FT-k9qzWced-v-bmuweBjXMBqkQ,5925
+apitally/client/base.py,sha256=L_9mbabVDikBG0fYOUu-l1y0VjdsZ2qLu9VSmcQveTM,10622
+apitally/client/logging.py,sha256=QMsKIIAFo92PNBUleeTgsrsQa7SEal-oJa1oOHUr1wI,507
+apitally/client/threading.py,sha256=89C6RdyUTTo5dg_ZAG1qIp9cNzzfAa7zEYejyV_gw00,6471
+apitally/django.py,sha256=U7lyjG97FrGGgA6_NHk3qHvWT69D2e5-37rtrS5PQDU,10251
+apitally/django_ninja.py,sha256=TFltgr03FzTnl83sUAXJj7R32u_g9DTZ9p-HuVKs4ZE,2785
+apitally/django_rest_framework.py,sha256=UmJvxxiKGRdaILSbg6jJY_cvAl-mpuPY1pM0FoQ4bg0,1587
+apitally/fastapi.py,sha256=YjnrRis8UG2M6Q3lkwizbtDXU7nPfCA4mebxG8XwveY,3334
+apitally/flask.py,sha256=7RI1odLYPRmlkQc-OU1HZJoHZxx2n249ftgsklpx2bM,6559
+apitally/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+apitally/starlette.py,sha256=C5Mz77BV33jp3HpmDko5Bjl2t7lxq_WUC6Nj3pcX1AU,9771
+apitally-0.3.2.dist-info/LICENSE,sha256=vbLzC-4TddtXX-_AFEBKMYWRlxC_MN0g66QhPxo8PgY,1065
+apitally-0.3.2.dist-info/METADATA,sha256=DR6-sdXPUywSoGGFf4M0OiDmoszGRW_BKqCuACh2ekc,6745
+apitally-0.3.2.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+apitally-0.3.2.dist-info/RECORD,,

apitally-0.3.0.dist-info/RECORD

@@ -1,16 +0,0 @@
-apitally/__init__.py,sha256=VrXpHDu3erkzwl_WXrqINBm9xWkcyUy53IQOj042dOs,22
-apitally/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-apitally/client/asyncio.py,sha256=JR3WLUN9dfvIhLhYA2gNL3v1DqAxLHbUWqko5Z5CKHs,5440
-apitally/client/base.py,sha256=dtFSHYTxpAFWqLcCSehzFL0qEWmNMjpBJQGDQMBxfQ4,10596
-apitally/client/threading.py,sha256=Y90IdkFwu8ysSzKDOFgPnZYYaEFVvZNGzF4uTMoODhU,5890
-apitally/django.py,sha256=U7lyjG97FrGGgA6_NHk3qHvWT69D2e5-37rtrS5PQDU,10251
-apitally/django_ninja.py,sha256=TFltgr03FzTnl83sUAXJj7R32u_g9DTZ9p-HuVKs4ZE,2785
-apitally/django_rest_framework.py,sha256=UmJvxxiKGRdaILSbg6jJY_cvAl-mpuPY1pM0FoQ4bg0,1587
-apitally/fastapi.py,sha256=YjnrRis8UG2M6Q3lkwizbtDXU7nPfCA4mebxG8XwveY,3334
-apitally/flask.py,sha256=7RI1odLYPRmlkQc-OU1HZJoHZxx2n249ftgsklpx2bM,6559
-apitally/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-apitally/starlette.py,sha256=XOTpCe2Oiv7IvjljVx14w-hTnNzOllxnUpRXxCfeABY,9347
-apitally-0.3.0.dist-info/LICENSE,sha256=vbLzC-4TddtXX-_AFEBKMYWRlxC_MN0g66QhPxo8PgY,1065
-apitally-0.3.0.dist-info/METADATA,sha256=wsjv5c_GoE2bRby8FWekm4IpLk6IURgHlAFbkSRoh1Q,5453
-apitally-0.3.0.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-apitally-0.3.0.dist-info/RECORD,,