apitally 0.12.0__tar.gz → 0.13.0__tar.gz

apitally-0.13.0/.github/workflows/publish.yaml

@@ -0,0 +1,24 @@
+name: Publish
+on:
+  release:
+    types: [published]
+permissions:
+  id-token: write
+  contents: read
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: release
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "0.4.29"
+          enable-cache: true
+      - name: Build package
+        run: uv build
+      - name: Publish package to PyPI
+        run: uv publish

apitally-0.13.0/.github/workflows/summary.yaml

@@ -0,0 +1,16 @@
+name: Summary
+on:
+  push:
+    branches-ignore:
+      - main
+jobs:
+  wait-for-triggered-checks:
+    runs-on: ubuntu-latest
+    permissions:
+      checks: read
+    steps:
+      - name: Wait for all triggered status checks
+        uses: poseidon/wait-for-status-checks@v0.6.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ignore_pattern: ^codecov/.+

apitally-0.13.0/.github/workflows/tests.yaml

@@ -0,0 +1,97 @@
+name: Tests
+on:
+  push:
+    paths-ignore:
+      - .gitignore
+      - LICENSE
+      - README.md
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check-pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - uses: pre-commit/action@v3.0.1
+
+  test-coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "0.4.29"
+          enable-cache: true
+      - name: Install Python
+        run: uv python install 3.12
+      - name: Install dependencies
+        run: uv sync --all-extras --frozen
+      - name: Run checks
+        run: uv run make check
+      - name: Run tests and create coverage report
+        run: uv run make test-coverage
+      - name: Upload coverage report to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  test-matrix:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        deps:
+          - starlette
+          - fastapi starlette
+          - fastapi==0.109.0 starlette
+          - fastapi==0.100.1 starlette
+          - fastapi==0.88.0 starlette
+          - flask
+          - flask==2.3.*
+          - flask==2.0.3 Werkzeug==2.*
+          - djangorestframework django uritemplate inflection
+          - djangorestframework django==4.2.* uritemplate inflection
+          - djangorestframework==3.12.* django==3.2.* uritemplate
+          - djangorestframework==3.10.* django==2.2.* uritemplate
+          - django-ninja django
+          - django-ninja==0.22.* django
+          - django-ninja==0.18.0 django
+          - litestar
+          - litestar==2.6.1
+          - litestar==2.3.0
+          - litestar==2.0.1
+        exclude:
+          - python: "3.12"
+            deps: fastapi==0.100.1 starlette
+          - python: "3.12"
+            deps: fastapi==0.87.0 starlette
+          - python: "3.12"
+            deps: djangorestframework==3.12.* django==3.2.* uritemplate
+          - python: "3.12"
+            deps: djangorestframework==3.10.* django==2.2.* uritemplate
+          - python: "3.12"
+            deps: litestar==2.0.1
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "0.4.29"
+          enable-cache: true
+      - name: Install Python
+        run: uv python install ${{ matrix.python }}
+      - name: Build Python package wheel
+        run: uv build --wheel
+      - name: Install test dependencies
+        run: uv sync --no-install-project --only-group test --frozen
+      - name: Install app dependencies
+        run: uv pip install ${{ matrix.deps }} ./dist/apitally-*.whl
+      - name: Run tests
+        run: uv run make test

apitally-0.13.0/.gitignore

@@ -0,0 +1,58 @@
+notebooks/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Unit test / coverage reports
+.coverage
+.cache
+coverage.xml
+.pytest_cache/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# Environments
+.venv/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# Visual Studio Code
+.vscode/
+
+# Local History for Visual Studio Code
+.history/
+
+# macOS
+.DS_Store

apitally-0.13.0/.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+default_language_version:
+  python: "3.12"
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.7.2
+    hooks:
+      - id: ruff
+        args: ["--fix", "--exit-non-zero-on-fix"]
+      - id: ruff-format
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.4.29
+    hooks:
+      - id: uv-lock

apitally-0.13.0/Makefile

@@ -0,0 +1,17 @@
+.PHONY: format check test test-coverage
+
+format:
+	ruff check apitally tests --fix --select I
+	ruff format apitally tests
+
+check:
+	uv lock --locked
+	ruff check apitally tests
+	ruff format --diff apitally tests
+	mypy --install-types --non-interactive apitally tests
+
+test:
+	pytest -v --tb=short
+
+test-coverage:
+	pytest -v --tb=short --cov --cov-report=xml

{apitally-0.12.0 → apitally-0.13.0}/PKG-INFO

@@ -1,49 +1,64 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: apitally
-Version: 0.12.0
+Version: 0.13.0
 Summary: Simple API monitoring & analytics for REST APIs built with FastAPI, Flask, Django, Starlette and Litestar.
-Home-page: https://apitally.io
-License: MIT
-Author: Apitally
-Author-email: hello@apitally.io
-Requires-Python: >=3.8,<4.0
+Project-URL: Homepage, https://apitally.io
+Project-URL: Documentation, https://docs.apitally.io
+Project-URL: Repository, https://github.com/apitally/apitally-py
+Author-email: Apitally <hello@apitally.io>
+License: MIT License
+License-File: LICENSE
 Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
 Classifier: Framework :: FastAPI
 Classifier: Framework :: Flask
 Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
 Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware
+Classifier: Topic :: Software Development
+Classifier: Topic :: System :: Monitoring
 Classifier: Typing :: Typed
+Requires-Python: <4.0,>=3.8
+Requires-Dist: backoff>=2.0.0
 Provides-Extra: django-ninja
+Requires-Dist: django-ninja>=0.18.0; extra == 'django-ninja'
+Requires-Dist: django<5,>=2.2; (python_version < '3.10') and extra == 'django-ninja'
+Requires-Dist: django>=2.2; (python_version >= '3.10') and extra == 'django-ninja'
+Requires-Dist: requests>=2.26.0; extra == 'django-ninja'
 Provides-Extra: django-rest-framework
+Requires-Dist: django<5,>=2.2; (python_version < '3.10') and extra == 'django-rest-framework'
+Requires-Dist: django>=2.2; (python_version >= '3.10') and extra == 'django-rest-framework'
+Requires-Dist: djangorestframework>=3.10.0; extra == 'django-rest-framework'
+Requires-Dist: inflection>=0.5.1; extra == 'django-rest-framework'
+Requires-Dist: requests>=2.26.0; extra == 'django-rest-framework'
+Requires-Dist: uritemplate>=3.0.0; extra == 'django-rest-framework'
 Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.88.0; extra == 'fastapi'
+Requires-Dist: httpx>=0.22.0; extra == 'fastapi'
+Requires-Dist: starlette<1.0.0,>=0.22.0; extra == 'fastapi'
 Provides-Extra: flask
+Requires-Dist: flask>=2.0.0; extra == 'flask'
+Requires-Dist: requests>=2.26.0; extra == 'flask'
 Provides-Extra: litestar
+Requires-Dist: httpx>=0.22.0; extra == 'litestar'
+Requires-Dist: litestar>=2.0.0; extra == 'litestar'
 Provides-Extra: sentry
+Requires-Dist: sentry-sdk>=2.2.0; extra == 'sentry'
 Provides-Extra: starlette
-Requires-Dist: backoff (>=2.0.0)
-Requires-Dist: django (>=2.2) ; (python_version >= "3.10") and (extra == "django-ninja" or extra == "django-rest-framework")
-Requires-Dist: django (>=2.2,<5) ; (python_version < "3.10") and (extra == "django-ninja" or extra == "django-rest-framework")
-Requires-Dist: django-ninja (>=0.18.0) ; extra == "django-ninja"
-Requires-Dist: djangorestframework (>=3.10.0) ; extra == "django-rest-framework"
-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 == "litestar" or extra == "starlette"
-Requires-Dist: inflection (>=0.5.1) ; extra == "django-rest-framework"
-Requires-Dist: litestar (>=2.0.0) ; extra == "litestar"
-Requires-Dist: requests (>=2.26.0) ; extra == "django-ninja" or extra == "django-rest-framework" or extra == "flask"
-Requires-Dist: sentry-sdk (>=2.2.0) ; extra == "sentry"
-Requires-Dist: starlette (>=0.21.0,<1.0.0) ; extra == "fastapi" or extra == "starlette"
-Requires-Dist: uritemplate (>=3.0.0) ; extra == "django-rest-framework"
-Project-URL: Documentation, https://docs.apitally.io
-Project-URL: Repository, https://github.com/apitally/apitally-py
+Requires-Dist: httpx>=0.22.0; extra == 'starlette'
+Requires-Dist: starlette<1.0.0,>=0.21.0; extra == 'starlette'
 Description-Content-Type: text/markdown
 
 <p align="center">
@@ -193,4 +208,3 @@ on GitHub or
 ## License
 
 This library is licensed under the terms of the MIT license.
-

apitally-0.13.0/apitally/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.0"

{apitally-0.12.0 → apitally-0.13.0}/apitally/client/base.py

@@ -4,6 +4,7 @@ import asyncio
 import contextlib
 import os
 import re
+import sys
 import threading
 import time
 import traceback
@@ -328,7 +329,11 @@ class ServerErrorCounter:
         cutoff = MAX_EXCEPTION_TRACEBACK_LENGTH - len(prefix)
         lines = []
         length = 0
-        for line in traceback.format_exception(exception)[::-1]:
+        if sys.version_info >= (3, 10):
+            traceback_lines = traceback.format_exception(exception)
+        else:
+            traceback_lines = traceback.format_exception(type(exception), exception, exception.__traceback__)
+        for line in traceback_lines[::-1]:
             if length + len(line) > cutoff:
                 lines.append(prefix)
                 break

{apitally-0.12.0 → apitally-0.13.0}/apitally/litestar.py

@@ -72,16 +72,31 @@ class ApitallyPlugin(InitPluginProtocol):
                 response_time = 0.0
                 response_headers = Headers()
                 response_body = b""
+                response_size = 0
+                response_chunked = False
                 start_time = time.perf_counter()
 
                 async def send_wrapper(message: Message) -> None:
-                    nonlocal response_time, response_status, response_headers, response_body
+                    nonlocal \
+                        response_time, \
+                        response_status, \
+                        response_headers, \
+                        response_body, \
+                        response_size, \
+                        response_chunked
                     if message["type"] == "http.response.start":
                         response_time = time.perf_counter() - start_time
                         response_status = message["status"]
                         response_headers = Headers(message["headers"])
-                    elif message["type"] == "http.response.body" and response_status == 400:
-                        response_body += message["body"]
+                        response_chunked = (
+                            response_headers.get("Transfer-Encoding") == "chunked"
+                            or "Content-Length" not in response_headers
+                        )
+                    elif message["type"] == "http.response.body":
+                        if response_chunked:
+                            response_size += len(message.get("body", b""))
+                        if response_status == 400:
+                            response_body += message.get("body", b"")
                     await send(message)
 
                 await app(scope, receive, send_wrapper)
@@ -91,6 +106,7 @@ class ApitallyPlugin(InitPluginProtocol):
                     response_time=response_time,
                     response_headers=response_headers,
                     response_body=response_body,
+                    response_size=response_size,
                 )
             else:
                 await app(scope, receive, send)  # pragma: no cover
@@ -104,6 +120,7 @@ class ApitallyPlugin(InitPluginProtocol):
         response_time: float,
         response_headers: Headers,
         response_body: bytes,
+        response_size: int = 0,
     ) -> None:
         if response_status < 100 or not request.route_handler.paths:
             return  # pragma: no cover
@@ -120,7 +137,7 @@ class ApitallyPlugin(InitPluginProtocol):
             status_code=response_status,
             response_time=response_time,
             request_size=request.headers.get("Content-Length"),
-            response_size=response_headers.get("Content-Length"),
+            response_size=response_size or response_headers.get("Content-Length"),
         )
         if response_status == 400 and response_body and len(response_body) < 4096:
             with contextlib.suppress(json.JSONDecodeError):

{apitally-0.12.0 → apitally-0.13.0}/apitally/starlette.py

@@ -59,40 +59,53 @@ class ApitallyMiddleware:
         if scope["type"] == "http" and scope["method"] != "OPTIONS":
             request = Request(scope)
             response_status = 0
-            response_time = 0.0
+            response_time: Optional[float] = None
             response_headers = Headers()
             response_body = b""
+            response_size = 0
+            response_chunked = False
+            exception: Optional[BaseException] = None
             start_time = time.perf_counter()
 
             async def send_wrapper(message: Message) -> None:
-                nonlocal response_time, response_status, response_headers, response_body
+                nonlocal \
+                    response_time, \
+                    response_status, \
+                    response_headers, \
+                    response_body, \
+                    response_size, \
+                    response_chunked
                 if message["type"] == "http.response.start":
                     response_time = time.perf_counter() - start_time
                     response_status = message["status"]
                     response_headers = Headers(scope=message)
-                elif message["type"] == "http.response.body" and response_status == 422:
-                    response_body += message["body"]
+                    response_chunked = (
+                        response_headers.get("Transfer-Encoding") == "chunked"
+                        or "Content-Length" not in response_headers
+                    )
+                elif message["type"] == "http.response.body":
+                    if response_chunked:
+                        response_size += len(message.get("body", b""))
+                    if response_status == 422:
+                        response_body += message.get("body", b"")
                 await send(message)
 
             try:
                 await self.app(scope, receive, send_wrapper)
             except BaseException as e:
-                self.add_request(
-                    request=request,
-                    response_status=500,
-                    response_time=time.perf_counter() - start_time,
-                    response_headers=response_headers,
-                    response_body=response_body,
-                    exception=e,
-                )
+                exception = e
                 raise e from None
-            else:
+            finally:
+                if response_time is None:
+                    response_time = time.perf_counter() - start_time
                 self.add_request(
                     request=request,
                     response_status=response_status,
                     response_time=response_time,
                     response_headers=response_headers,
                     response_body=response_body,
+                    response_size=response_size,
+                    exception=exception,
                 )
         else:
             await self.app(scope, receive, send)  # pragma: no cover
@@ -104,6 +117,7 @@ class ApitallyMiddleware:
         response_time: float,
         response_headers: Headers,
         response_body: bytes,
+        response_size: int = 0,
         exception: Optional[BaseException] = None,
     ) -> None:
         path_template, is_handled_path = self.get_path_template(request)
@@ -111,6 +125,8 @@ class ApitallyMiddleware:
             consumer = self.get_consumer(request)
             consumer_identifier = consumer.identifier if consumer else None
             self.client.consumer_registry.add_or_update_consumer(consumer)
+            if response_status == 0 and exception is not None:
+                response_status = 500
             self.client.request_counter.add_request(
                 consumer=consumer_identifier,
                 method=request.method,
@@ -118,7 +134,7 @@ class ApitallyMiddleware:
                 status_code=response_status,
                 response_time=response_time,
                 request_size=request.headers.get("Content-Length"),
-                response_size=response_headers.get("Content-Length"),
+                response_size=response_size or response_headers.get("Content-Length"),
             )
             if response_status == 422 and response_body and response_headers.get("Content-Type") == "application/json":
                 with contextlib.suppress(json.JSONDecodeError):

apitally-0.13.0/pyproject.toml

@@ -0,0 +1,145 @@
+[project]
+name = "apitally"
+description = "Simple API monitoring & analytics for REST APIs built with FastAPI, Flask, Django, Starlette and Litestar."
+authors = [
+    { name = "Apitally", email = "hello@apitally.io" },
+]
+readme = "README.md"
+license = { text = "MIT License" }
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "Framework :: Django",
+    "Framework :: FastAPI",
+    "Framework :: Flask",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware",
+    "Topic :: Software Development",
+    "Topic :: System :: Monitoring",
+    "Typing :: Typed",
+]
+requires-python = ">=3.8,<4.0"
+dependencies = [
+    "backoff>=2.0.0",
+]
+dynamic = ["version"]
+
+[project.optional-dependencies]
+django_ninja = [
+    "django>=2.2,<5; python_version<'3.10'",
+    "django>=2.2; python_version>='3.10'",
+    "django-ninja>=0.18.0",
+    "requests>=2.26.0",
+]
+django_rest_framework = [
+    "django>=2.2,<5; python_version<'3.10'",
+    "django>=2.2; python_version>='3.10'",
+    "djangorestframework>=3.10.0",
+    "uritemplate>=3.0.0", # required for schema generation
+    "inflection>=0.5.1", # required for schema generation
+    "requests>=2.26.0",
+]
+fastapi = [
+    "fastapi>=0.88.0",
+    "starlette>=0.22.0,<1.0.0",
+    "httpx>=0.22.0",
+]
+flask = [
+    "flask>=2.0.0",
+    "requests>=2.26.0",
+]
+litestar = [
+    "litestar>=2.0.0",
+    "httpx>=0.22.0",
+]
+sentry = [
+    "sentry-sdk>=2.2.0",
+]
+starlette = [
+    "starlette>=0.21.0,<1.0.0",
+    "httpx>=0.22.0",
+]
+
+[project.urls]
+Homepage = "https://apitally.io"
+Documentation = "https://docs.apitally.io"
+Repository = "https://github.com/apitally/apitally-py"
+
+[dependency-groups]
+dev = [
+    "ipykernel~=6.29.0",
+    "mypy~=1.13.0",
+    "pre-commit~=3.5.0; python_version<'3.9'",
+    "pre-commit~=4.0.1; python_version>='3.9'",
+    "ruff~=0.7.0",
+]
+test = [
+    "pytest~=7.4.4; python_version<'3.9'",
+    "pytest~=8.3.3; python_version>='3.9'",
+    "pytest-asyncio~=0.21.2",
+    "pytest-cov~=5.0.0; python_version<'3.9'",
+    "pytest-cov~=6.0.0; python_version>='3.9'",
+    "pytest-httpx~=0.22.0; python_version<'3.9'",
+    "pytest-httpx~=0.33.0; python_version>='3.9'",
+    "pytest-mock~=3.14.0",
+    "requests-mock~=1.12.1",
+]
+types = [
+    "django-types",
+    "djangorestframework-types",
+    "types-colorama",
+    "types-docutils",
+    "types-pygments",
+    "types-pyyaml",
+    "types-requests",
+    "types-setuptools",
+    "types-six",
+    "types-ujson",
+]
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.uv]
+default-groups = ["dev", "test", "types"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py312"
+
+[tool.ruff.lint]
+ignore = ["E501"]
+select = ["E", "F", "W", "I"]
+
+[tool.ruff.lint.isort]
+lines-after-imports = 2
+
+[tool.mypy]
+python_version = "3.12"
+check_untyped_defs = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.coverage.run]
+source = ["apitally"]
+
+[tool.coverage.report]
+exclude_lines = ["pragma: no cover", "if TYPE_CHECKING"]

apitally-0.13.0/renovate.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["github>apitally/renovate-config"],
+  "ignoreDeps": ["pytest-asyncio"]
+}