Skip to main content

bowmark-web-stubs

PEP 561 type stubs for bowmark-web — the whole Bowmark capability surface, typed.

pip install bowmark-web bowmark-web-stubs
async with session() as bm:
    found = await bm.providers.gymshark.search({"query": "hoodie"})
    #                                  ^ your editor knows every provider, every
    #                                    function, every argument and every field

Why it is a separate distribution

PEP 561 is explicit: "The name of the stub package MUST follow the scheme foopkg-stubs." So this is mandated rather than chosen, and PyPI has no rename, alias or redirect mechanism to undo it with.

bowmark-web still ships py.typed, so installing only the client keeps the client's own types and loses only the catalog.

This distribution is marked partial, which matters: without that marker a checker resolving bowmark_web-stubs stops looking at bowmark_web altogether, and every private submodule becomes unresolvable to anyone who imports one.

What is in it, and where it comes from

bowmark_web-stubs/__init__.pyi is generated — from the same LibraryManifest that produces the TypeScript declarations in @bowmark/web. One manifest, one refusal rule, two languages, so the two clients cannot come to disagree about what the library offers. A gate in the source repo asserts the parity on every change.

Everything the library can do is in CAPABILITIES.md and PROVIDERS.md, regenerated daily.

What it deliberately does NOT type

Some functions are absent, on purpose. A function whose declared argument is a bare destructuring pattern with no field types, or whose signature names a type its own documentation never defines, gets a comment in place of a signature naming it and saying why. Those functions are real and callable at runtime — the stub withholds only the compile-time claim, because we have none to make. A (*args: Any) -> Any stand-in would pass every check and tell you nothing.

Family members are not enumerated. bowmark.providers.gymshark.search(…) works and is not in these stubs: there are half a million Shopify storefronts and no manifest carries one. Type checkers will not complete them; the client sends them happily.

Everything leans toward accepting. An argument-position list is Sequence[T], a number is float (so an int is fine), and anything the schema could not model is Any. A stub that refuses a correct argument is a red squiggle you cannot turn off, and that is a worse failure than one round trip.

Versioning

bowmark-web, bowmark-web-stubs and @bowmark/web on npm are released together and always carry the same version. A skew would mean one ecosystem is on an older contract.

Release files for bowmark-web-stubs 1.22.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bowmark-web-stubs 1.22.1
File Size Uploaded
bowmark_web_stubs-1.22.1.tar.gz 360.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for bowmark-web-stubs 1.22.1
File Interpreter ABI Platform
bowmark_web_stubs-1.22.1-py3-none-any.whl Python 3 none any Details

Total release size: 723.8 kB

Release files / bowmark_web_stubs-1.22.1.tar.gz

Download URL bowmark_web_stubs-1.22.1.tar.gz
Size 360.7 kB
Tags Source
SHA-256 checksum
How to use checksums
5dbc54fcfb0fd9a3500d1f5f37e71dfad28aefe99978e757850b9b1a1f134adc
BLAKE2b-256 checksum
How to use checksums
8ca85637345992d4486cb4661711ee16df615ee0aa8257137cd3ef4aca2f4f23
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.15 {"installer":{"name":"uv","version":"0.12.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / bowmark_web_stubs-1.22.1-py3-none-any.whl

Download URL bowmark_web_stubs-1.22.1-py3-none-any.whl
Size 363.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
22fa0ca926172f36099111b78fb5aeedf70c878f7744c862c37973d315a02fd5
BLAKE2b-256 checksum
How to use checksums
e222c97c63a2199e2901a20b311b3692eb8a3f5597f65248c48a00ae63cbaff4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.15 {"installer":{"name":"uv","version":"0.12.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page