shipeasy (Python)
Server SDK for Shipeasy — feature flags, dynamic configs, kill switches, A/B experiments, and metric tracking. Server-key only; never embed in a browser.
📚 Full documentation: https://shipeasy-ai.github.io/sdk-python/ — also browsable under
docs/. This README is generated from those docs.
🤖 Using an AI agent?
This SDK ships an installable agent skill — a copy-paste-ready guide to
configure() + Client(user), testing, experiments, error reporting, and more,
with links the agent can pull for deeper docs:
- Skill:
docs/skill/SKILL.md· raw:https://shipeasy-ai.github.io/sdk-python/skill/SKILL.md - Install it (ships with the package — no network):
shipeasy-skill install→.claude/skills/shipeasy-python/SKILL.md(or via the Shipeasy CLI:shipeasy docs skill --sdk python --install)
Humans: you can copy that skill straight into your own project's agent skills
directory (e.g. .claude/skills/shipeasy-python/SKILL.md) so your
coding agent always uses the correct Shipeasy patterns. Every doc page and snippet
is also fetchable by URL — start from the manifest at https://shipeasy-ai.github.io/sdk-python/manifest.json.
Install
# pip
pip install shipeasy
# poetry
poetry add shipeasy
# uv
uv add shipeasy
Requires Python 3.9+. Per-framework setup (Django / Flask / FastAPI) and the anon-id middleware are on the Installation page.
Quickstart — configure() once, then Client(user) per request
import shipeasy
shipeasy.configure(
api_key="sdk_server_...",
attributes=lambda u: {"user_id": u.id, "country": u.country, "plan": u.plan},
)
# construct once per callsite (cheap; binds the user)
client = shipeasy.Client(current_user)
if client.get_flag("new_checkout"):
...
config = client.get_config("billing_copy")
a = client.universe("checkout").assign() # ≤1 experiment; exposure logs on first get()
if a.get("button_color") == "green":
...
client.track("purchase", {"amount": 49}) # on conversion
Constructing Client(user) before configure() raises RuntimeError.
Documentation
| Page | What |
|---|---|
| Overview | The configure() + Client(user) model. |
| Installation | Install, frameworks (Django / Flask / FastAPI), configure() wiring. |
| Configuration | Keys, attributes, one-shot vs poll, every option. |
| Feature flags | get_flag, get_flag_detail, defaults. |
| Dynamic configs | get_config, typed decode, defaults. |
| Kill switches | get_killswitch, named switches. |
| Experiments | get_experiment, log_exposure, track. |
| Internationalization | SSR loader tag (rendering is client-side). |
| Error reporting | see() structured error reporting. |
| Testing | configure_for_testing / configure_for_offline, overrides. |
| OpenFeature | ShipeasyProvider (OpenFeature server provider). |
| Advanced | Anon-id middleware, private attributes, sticky bucketing, SSR. |
| Admin API client | Optional shipeasy.admin client for administering resources (generated from the OpenAP… |
Copy-paste snippets live under docs/snippets/
(release · metrics · i18n · ops); an installable agent skill is at
docs/skill/SKILL.md.
Testing
Use configure_for_testing() — the test-mode sibling of configure(). It does zero network, needs no api_key, and seeds the values your code under test should see via override arguments. Then read through the ordinary shipeasy.Client(user) — the same call your production code uses.
import shipeasy
from shipeasy import Client
shipeasy.configure_for_testing(
flags={"new_checkout": True},
configs={"billing_copy": {"title": "Welcome"}},
)
# construct once per callsite (cheap; binds the user)
client = Client({"user_id": "u_123"})
assert client.get_flag("new_checkout") is True
assert client.get_config("billing_copy") == {"title": "Welcome"}
# track() and get()-triggered exposure are no-ops in test mode — safe to call, send nothing
client.track("purchase", {"amount": 49})
More — the on-the-spot override helpers and a working example
shipeasy-snapshot.json — on the Testing page.
License
MIT. Evaluation is tested against the cross-language MurmurHash3 vectors in
experiment-platform/04-evaluation.md.
1 maintainer
Metadata
1 maintainer
Release files for shipeasy 0.23.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| shipeasy-0.23.0.tar.gz | 182.4 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| shipeasy-0.23.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 317.3 kB
Release files / shipeasy-0.23.0.tar.gz
| Download URL | shipeasy-0.23.0.tar.gz |
|---|---|
| Size | 182.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2c796287a67f4bdf8a9179e1fa4beffc2204b725387542883d241f6f6764639f
|
|
BLAKE2b-256 checksum How to use checksums |
9460437ed3315f4487c67d1a025eaca24bd7ec7f5aff1346d06198cbcb0d0c0d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 27, 2026.
Transparency logRelease files / shipeasy-0.23.0-py3-none-any.whl
| Download URL | shipeasy-0.23.0-py3-none-any.whl |
|---|---|
| Size | 134.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b1cc15a2d82a30e5c7c11baaf92c6585b1b5feac3c875bc9954ae8c8697c946b
|
|
BLAKE2b-256 checksum How to use checksums |
c9f21e33b2d16cf71d0ff57e517daa76231185c67fdbe566b64cbb7e6664e088
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 27, 2026.
Transparency logSecurity for shipeasy 0.23.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for shipeasy-0.23.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 27, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
