Metadata-Version: 2.4
Name: yumeclient
Version: 0.1.6
Summary: Async Python facade for bogdanfinn/tls-client
License: MIT
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: test
Requires-Dist: pytest>=8; extra == "test"
Requires-Dist: pytest-asyncio>=0.24; extra == "test"
Dynamic: license-file

# Yume Client

Async Python facade over `github.com/bogdanfinn/tls-client` v1.16.0. The Python layer never substitutes another TLS implementation: it calls the upstream Go `cffi_src` client through a small cgo shared-library adapter. The Go client remains responsible for uTLS fingerprints, HTTP/2/3, proxies, cookies and profiles.

## Build

Requires Go 1.24.1, a C compiler, and network access for Go modules. The importable Python package lives in `yumeclient/`; build from the `native/` directory:

```sh
cd native && go build -buildmode=c-shared -o ../yumeclient/yumeclient.so .
cd .. && python -m pip install -e .
```

On Windows use `-o ../yumeclient/yumeclient.dll`; on macOS use `.dylib`. Set `YUMECLIENT_LIBRARY` to the resulting library path if it is elsewhere. The shared library must be built for the host OS/architecture.

See [USAGE.md](USAGE.md) for API examples, profiles, transport modes, cookies, multipart behavior, build commands, and known limitations.

Upstream license: MIT; see `UPSTREAM-LICENSE`. Profile names and JSON field spellings track upstream v1.16.0.
