Server status ...

magogi/prod/: mgf-apiprobe-0.5.8 metadata and description

Simple index Newer version available

REST API verification — typed probes, checks, and findings. Sibling of mgf-common.

author Bassam Alsanie, mgf-apiprobe contributors
classifiers
  • Development Status :: 3 - Alpha
  • Intended Audience :: Developers
  • License :: OSI Approved :: MIT License
  • Operating System :: MacOS
  • Operating System :: Microsoft :: Windows
  • Operating System :: POSIX :: Linux
  • Programming Language :: Python :: 3
  • Programming Language :: Python :: 3.11
  • Programming Language :: Python :: 3.12
  • Programming Language :: Python :: 3.13
  • Topic :: Software Development :: Libraries
  • Topic :: Software Development :: Quality Assurance
  • Topic :: Software Development :: Testing
  • Typing :: Typed
description_content_type text/markdown
keywords api, contract-testing, httpx, openapi, rest, verification
license MIT
license_file
  • LICENSE
metadata_version 2.4
project_urls
  • Homepage, https://codeberg.org/magogi-admin/mgf-apiprobe
  • Issues, https://codeberg.org/magogi-admin/mgf-apiprobe/issues
requires_dist
  • httpx>=0.27
  • jmespath>=1.0
  • jsonpath-ng>=1.6
  • mgf-common<0.48,>=0.41
  • pydantic>=2.7
  • coverage>=7.0; extra == 'dev'
  • hypothesis>=6.100; extra == 'dev'
  • import-linter>=2.0; extra == 'dev'
  • mgf-test-supervisor<0.2,>=0.1.3; extra == 'dev'
  • mypy>=1.10; extra == 'dev'
  • pytest-asyncio>=0.23; extra == 'dev'
  • pytest-timeout<3,>=2.3; extra == 'dev'
  • pytest>=8.0; extra == 'dev'
  • respx>=0.21; extra == 'dev'
  • ruff<0.16,>=0.4; extra == 'dev'
  • types-pyyaml>=6.0; extra == 'dev'
  • faker>=25; extra == 'faker'
  • openapi-core>=0.19; extra == 'openapi'
  • cryptography>=42; extra == 'signing'
  • mgf-common[standards]<0.48,>=0.46; extra == 'standards'
requires_python >=3.11

Because this project isn't in the mirror_whitelist, no releases from root/pypi are included.

File Tox results History
mgf_apiprobe-0.5.8-py3-none-any.whl
Size
93 KB
Type
Python Wheel
Python
3

mgf-apiprobe

REST API verification — typed probes, checks, and findings.

Shape: Federation sibling of mgf-common. The current mgf-common pin window is shown in this package's Codeberg registry — sourced from pyproject.toml at release time, so this README can't go stale. (Per v2.6 DOC-01 / project-shape taxonomy. PAPER-38.)

mgf-apiprobe is the API-verification sibling of mgf-common. It builds on mgf-common's settings, error, and observability primitives, and adds:

Install

pip install mgf-apiprobe

Optional extras (forward-declared):

pip install 'mgf-apiprobe[openapi]'   # OpenAPI ingestion
pip install 'mgf-apiprobe[faker]'     # Faker-backed factories
pip install 'mgf-apiprobe[signing]'   # Cassette signing

Quick start

from mgf.apiprobe import Probe, Suite, BearerAuth

probe = (
    Probe.get("https://httpbin.org/get")
    .with_auth(BearerAuth(token="..."))
    .expects_status(200)
    .expects_json_shape({"url": str, "headers": dict})
)

suite = Suite([probe])
report = await suite.run()
print(report.to_human())

Standards

Conformance: L2 per mgf-standard/docs/standards/. Per-rule audit ledger: docs/inprogress/MGF_STANDARDS_CONFORMANCE.md.

The L2 floor means every federation MUST rule applies, evidenced by the tracker: BaseAppSettings, AppError hierarchy, structured logging, redaction, py.typed, SemVer with the 0.x carve-out, ≥80% coverage gate, no secrets in cassettes/logs. The earlier "L1 — Production-Ready" framing in this README was the pre-v2.7 nomenclature; the current standards (per docs/standards/README.md §"Conformance levels for projects") define L1 — Lite / L2 — Standard / L3 — Strict with L2 as the federation-sibling baseline.

Layout

File Purpose
DESIGN.md The design spec (≈ 1990 lines). WHAT we're building.
HANDOFF.md Integration plan. HOW it ships as a sibling of mgf-common.
LIFT_CHECKLIST.md Federation conformance acknowledgment.

License

MIT. See LICENSE (TBD).