convilyn 1.1.1b1__tar.gz

convilyn-1.1.1b1/.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+*.py[cod]
+.venv/
+venv/
+dist/
+build/
+*.egg-info/
+.coverage
+coverage.xml
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/

convilyn-1.1.1b1/CHANGELOG.md

@@ -0,0 +1,241 @@
+# Changelog — `convilyn` (consumer SDK)
+
+Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/);
+versioning follows [Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [1.1.1b1] — 2026-07-07
+
+### Security
+
+- **Storage URLs are validated before the client dials them.** The
+  client now rejects an upload/download URL whose host resolves to a
+  loopback, link-local, or private address (in addition to the existing
+  https-only check), so a malformed or tampered response cannot redirect
+  an upload or download to an internal target.
+- **Downloads are streamed with a size cap** instead of being buffered
+  whole in memory, so a very large or hostile response cannot exhaust
+  memory. Uploads are likewise capped (`MAX_UPLOAD_BYTES`) and fail fast.
+- **`base_url` must be https** for any non-loopback host — the API key
+  travels in an `Authorization` header, so an `http://` target is
+  refused to avoid sending it in cleartext. Loopback hosts may use http
+  for local development.
+- **WebSocket URLs must be `wss://`** for any non-loopback host, and
+  connection errors no longer include the auth token from the URL.
+
+### Changed
+
+- Docstrings, README, and CHANGELOG were revised for clarity; no public
+  API changed.
+
+## [1.1.0] — 2026-07-07
+
+First published release (PyPI). Sections below accumulated since 1.0.1;
+the `Removed` entries predate any published version, so no released
+consumer is affected.
+
+> **Events are polling-only in v1**: retrieve goal progress with
+> `client.goals.wait(...)` / `retrieve(...)`. The WebSocket gateway does
+> not accept consumer `ck_` keys yet; `goals.events()` streaming is
+> roadmap (see `docs/STABILITY.md`).
+
+### Fixed
+
+- `files.upload` now speaks the backend's presigned-**POST** upload grant: when the presign response carries `fields`, the SDK multipart-POSTs (fields verbatim, file part last) instead of PUTting — the backend switched input uploads to a size-capped S3 POST policy (`content-length-range`) and a PUT against the POST URL fails with S3 403. A grant without `fields` still uses the legacy presigned-PUT path, so the SDK works against both backend generations.
+- The synchronous `Convilyn` client now runs every call — and the final `close()` — on **one private, long-lived event loop** instead of a fresh `asyncio.run` loop per call. Per-call loops orphaned pooled `httpx` connections, which touched their already-closed loop at interpreter teardown and crashed the CLI on Windows (`RuntimeError: Event loop is closed`). Calling a sync method after `close()` now raises a clear `RuntimeError`, and calling one from inside a running event loop still raises with guidance to use `AsyncConvilyn`.
+- A **failed** conversion job now surfaces `JobFailedError` even when the backend attaches a 0-byte placeholder result file. `ResultFile.size` was `Field(gt=0)`, so parsing a failed job whose `resultFiles[0].size == 0` raised a pydantic `ValidationError` instead — masking the real failure. The bound is now `ge=0`.
+- `convert.create` now sends the discriminated-union tag as snake_case `processor_type` (was camelCase `processorType`); the file-conversion `JobRequest` discriminator is `processor_type` per the contract (`processorType` is only the *response* field name), so the previous key made the backend reject every conversion with HTTP 400 `union_tag_not_found`. File conversions now succeed against the current backend.
+- The CLI `--json` output now escapes non-ASCII (`ensure_ascii=True`); a raw glyph in a payload (e.g. a `✓` from a job) previously crashed with `UnicodeEncodeError` on a non-UTF-8 console (Windows `cp950`).
+- `goals.start(slots=...)` now sends the answers as `slotAnswers` (`[{slotId, value}]`); the previous `slots` payload had no matching field on the create endpoint and was silently dropped, so pre-seeded slot answers never reached the backend.
+- Goal-job parsing now coerces wire-`null` `pendingInterrupts` / `pendingSlots` / `fileIds` / `filledSlots` to an empty list/dict via a before-validator; the backend legitimately returns `null` for these, which previously raised a validation error on the non-optional fields and made the whole `GoalJob` unparseable.
+- File uploads from a path now send a length-bearing bytes body (so httpx emits `Content-Length`); the previous async-generator body made httpx use `Transfer-Encoding: chunked`, which an S3 presigned PUT rejects with HTTP 501. Path-based uploads now succeed against real storage.
+
+### Changed
+
+- **`goals.events()` failure now points at `wait()` polling.** The WS gateway
+  does not accept `ck_` keys in v1, so a connect failure's `WebSocketError`
+  message and the method docstring now spell out that WebSocket streaming is
+  polling-only for now (use `wait()`), mirroring the consumer-go guidance.
+- **Author-SDK / developer-portal tokens (`cvl_` / `cvi_`) are now rejected**
+  by `APIKey` / `Convilyn(api_key=...)` with a precise `AuthError`, instead of
+  being treated as acceptable consumer keys (they never authenticated against
+  the data plane — the backend answered with an opaque 401). The `ck_` prefix
+  and any unknown prefix are still accepted (forward-compat). Brings the Python
+  consumer SDK in line with the TypeScript one's `auth.ts` guard.
+
+### Removed
+
+- **BREAKING: `GoalJob.workflow_id`** — the backend's `GoalJobResponse` never
+  echoes `workflowId` (the *request* accepts it; the response does not), so the
+  attribute was always `None` at runtime. Removed pre-first-publish, so no
+  released consumer is affected. `goals.start(workflow_id=...)` /
+  `run(workflow_id=...)` and the `Workflow` / `WorkflowSummary` models are
+  unchanged. `GoalJob` is now conformance-mapped in `sdk/sdks.json`, so any
+  future field the wire doesn't speak fails CI instead of shipping silently.
+
+### Added
+
+- **`client.goals.start(..., llm_config_id=...)` / `run(..., llm_config_id=...)`**
+  — optionally pin a goal run to one of your stored BYO-LLM provider configs
+  (created in the console) so the run executes on your own provider/key. Omit it
+  to use your account default. Serialised as `llmConfigId`; honoured only when
+  BYO-LLM is enabled for your account, otherwise the run uses the platform
+  provider.
+
+### Fixed
+
+- **Default API base URL** — corrected to `https://api.convilyn.corenovus.com`
+  (was `https://api.convilyn.com`, which does not serve the API), so a default
+  `Convilyn()` reaches the real backend out of the box. The base URL is the host
+  root — resource paths carry their own `/api/v1` prefix.
+- **API-key prefix** — the canonical consumer key is now `ck_` (minted in the
+  API Console / Settings → API), matching the backend (`USER_API_KEY_PREFIX`)
+  and the docs. `ACCEPTED_KEY_PREFIXES` now includes `ck_` (the developer-portal
+  `cvl_` / `cvi_` tiers stay recognised); the quickstart + `convilyn doctor`
+  examples show `ck_`. The runnable `examples/*` now lead with `ck_` too,
+  completing the alignment.
+- **Stale post-rename references** — after the `sdk-consumer` →
+  `sdk-consumer-python` directory rename, the `pyproject.toml`
+  `[project.urls]` (Changelog / Source Code), the `examples/03` AGENT.md
+  reference, and the `examples/README.md` test-path link now point at
+  `sdk-consumer-python`.
+
+### Added
+
+- **`CONVILYN_BASE_URL` environment override** — the client now honours the
+  `CONVILYN_BASE_URL` env var (precedence: explicit `base_url=` arg →
+  `CONVILYN_BASE_URL` → default), so the CLI and SDK can target a dev/staging
+  API without code changes. `convilyn doctor` already surfaced this var and now
+  reports the URL the client actually dials.
+- **Public-API contract test** (`tests/contract/test_public_surface.py`) —
+  freezes `convilyn.__all__`, the per-resource method sets, and the
+  exception taxonomy, and fails if any `convilyn._internal` symbol leaks
+  into the public namespace or the surface grows unexpectedly. The keystone
+  guard behind the SemVer promise; see `docs/STABILITY.md`.
+- **`convilyn.config`** — a public module home for the resilience config
+  types (`RetryPolicy`, `ExponentialBackoffRetry`, `NoRetry`,
+  `AutoThrottleConfig`). They are still re-exported from the top-level
+  `convilyn` namespace, so `from convilyn import RetryPolicy` is unchanged —
+  but the documented home is now a non-underscore module rather than
+  `convilyn._internal`.
+- **`docs/STABILITY.md`** — the published stability & versioning policy:
+  what the public surface is, the SemVer promise, the deprecation policy,
+  and the documented `raw_request` escape-hatch caveat.
+
+- **`Convilyn(auto_throttle=...)`** — opt-in retry loop for
+  `QuotaExceededError`. Pass `True` for the default policy (1 retry,
+  60 s sleep cap, 5 s fallback delay) or an `AutoThrottleConfig` /
+  dict for tuned knobs. The SDK reads the server's
+  `details.retry_after_seconds` / `details.reset_at` hint when present
+  and gives up immediately if the implied sleep exceeds `max_sleep`,
+  so a misconfigured caller never blocks indefinitely.
+- **Soft-limit signalling** — any response carrying the
+  `X-Quota-State: soft_limit` header now emits a
+  `convilyn.throttle` log warning + Python `UserWarning` and returns
+  normally (forward-compat wiring; the backend will emit the header
+  once the gateway support lands).
+- **`client.account.usage_history(*, since=None)`** — list past usage
+  periods (one row per metric+period). Wraps
+  `GET /api/v1/payment/usage/history`; the new `UsageHistoryEntry`
+  model carries `metric`, `period_start`, `period_end`, `used`, and
+  optional `limit`. Pair with `client.account.get_quota()` for MTD
+  spend reviews.
+- `CostEstimate` now exposes `estimated_total_micro_u`,
+  `estimated_min_micro_u`, and `estimated_max_micro_u` (wire aliases
+  `estimatedTotalMicroU` / `estimatedMinMicroU` / `estimatedMaxMicroU`).
+  Use these to render the projected cost range; the legacy
+  `estimated_micro_u` upper-bound field stays for back-compat.
+
+### Changed
+
+- Renamed event types on `GoalEventType`: `specialist_started` →
+  `agent_step_started`, `specialist_finished` → `agent_step_finished`,
+  `handoff` → `orchestration_transition`. CLI glyphs follow.
+
+### Removed
+
+- `CostEstimate.max_iterations` and
+  `CostEstimate.llm_cost_per_iter_micro_u` are no longer surfaced on
+  the model. Callers should rely on the new cost-range triple
+  (min / total / max).
+
+### Documentation
+
+- The package (`convilyn/__init__.py`) and async-client (`client.py`)
+  docstrings now reflect the shipped resource surface — they previously
+  said resources "land in subsequent releases" / "follow-up commits"
+  while `client.files` / `convert` / `goals` / `workflows` / `account`
+  already ship.
+
+## [1.0.1] — 2026-06-30
+
+### Security
+
+- **`https`-only scheme guard on backend-supplied URLs.** `external_get` /
+  `external_put` (the presigned-URL download/upload paths) now reject any URL
+  whose scheme is not `https` (e.g. `http://`, `file://`, an internal address
+  over plain HTTP). This is defence-in-depth against a compromised or MITM'd
+  backend returning a downgrade/SSRF URL. Scheme — not host — is checked, so
+  every legitimate https presign host (S3, CloudFront, custom domains) still
+  works.
+- **`convert.download_to` refuses to write through an existing symlink** at the
+  destination path, so a pre-placed link cannot redirect the downloaded bytes.
+  Writing to a regular or new path is unaffected.
+- **`convilyn doctor` secret masking tightened** — diagnostics now reveal only
+  the first 3 characters (the key tier prefix) and no longer print the trailing
+  4 characters of an API key.
+
+## [1.0.0] — 2026-05-24
+
+First production release. The package surface has stabilised across the
+R1-R5 workstreams; the bump from `0.1.0` reflects API readiness, not a
+breaking change.
+
+### Added
+
+- **`client.account` resource** — `get_plan()` returns the caller's
+  billing tier; `get_quota(tools=..., max_iterations=...)` previews
+  workflow cost + returns the tier's quota verdict (`ok` /
+  `soft_limit` / `quota_exceeded`). Read-only, no side effects.
+- **`convilyn account` CLI** — `convilyn account plan` and
+  `convilyn account quota` mirror the resource. Both support `--json`
+  for pipe consumption.
+- **Typed billing exceptions**: `PlanRequiredError` (HTTP 402 +
+  `TIER_REQUIRED`) and `QuotaExceededError` (HTTP 402 +
+  `QUOTA_EXCEEDED`). Both subclass `APIError`, so existing
+  `except APIError:` handlers continue to catch them. Each carries an
+  `upgrade_url` for the caller's pricing CTA.
+- **`client.workflows` resource** — community marketplace surface:
+  `search`, `get`, `fork`, `publish`, `patch`, `like`.
+- **`client.goals` resource** — agentic AI workflows: `start`,
+  `wait`, `run`, `retrieve`, `fill_slot`, `confirm`, `cancel`, `retry`,
+  plus async-only `events()` WebSocket streaming.
+- **`convilyn goals` CLI** — drive AI workflows from the shell.
+  NDJSON streaming for `events`; pinned exit codes (0 / 1 / 2 / 3 / 130).
+- **`convilyn convert` CLI** + `client.convert` + `client.files`
+  resources (R1 ship).
+- **`convilyn doctor` CLI** — environment + connectivity diagnostics
+  for the SDK's dependencies and auth setup.
+- **`convilyn api` CLI** — `gh`-style escape hatch for any backend
+  endpoint the SDK has not wrapped yet.
+- **Production-grade resilience**: retry on 5xx / 429 / 408 with
+  exponential backoff + jitter, `Idempotency-Key` auto-stamped on
+  mutating verbs, `Retry-After` honoured.
+
+### Changed
+
+- Error envelope handling normalises three shapes: flat
+  `{code, message, ...}`, FastAPI `{"detail": {...}}`, and the older
+  `{"error": {...}}`. Callers now see the same typed exception
+  regardless of which endpoint raised.
+- License moved from speculative `Apache-2.0` placeholder to `MIT`
+  (matches the repo's existing precedent under `llm-gateway/LICENSE`).
+
+### Documentation
+
+- `docs/QUICKSTART.md` — 5-min Python + CLI walkthrough.
+- `docs/README.md` — PyPI landing page.
+- `AGENT.md` — SOLID seams + extension points for AI coding agents
+  contributing to the SDK.
+- 9 runnable examples under `examples/01_*.py` … `09_account_quota.py`.

convilyn-1.1.1b1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may accept (and charge a
+      fee for) acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 CoreNovus contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing
+   permissions and limitations under the License.

convilyn-1.1.1b1/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: convilyn
+Version: 1.1.1b1
+Summary: Official Convilyn client SDK — file conversion, agentic workflows, community library
+Project-URL: Homepage, https://convilyn.corenovus.com
+Project-URL: Documentation, https://docs.convilyn.corenovus.com
+Project-URL: Issues, https://github.com/CoreNovus/convilyn-python/issues
+Project-URL: Repository, https://github.com/CoreNovus/convilyn-python
+Project-URL: Source Code, https://github.com/CoreNovus/convilyn-python
+Project-URL: Changelog, https://github.com/CoreNovus/convilyn-python/blob/main/CHANGELOG.md
+Author-email: Convilyn <sdk@convilyn.corenovus.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agent,ai,convilyn,file-conversion,mcp,workflow
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: click<9.0.0,>=8.0.0
+Requires-Dist: httpx<1.0.0,>=0.25.0
+Requires-Dist: pydantic<3.0.0,>=2.0.0
+Requires-Dist: typing-extensions>=4.7.0; python_version < '3.11'
+Requires-Dist: websockets<17.0,>=13.0
+Provides-Extra: author
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: respx>=0.22.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# convilyn
+
+Official Python client for the [Convilyn](https://convilyn.corenovus.com) API —
+convert files, run AI workflows, and ship in five lines of Python or a
+single shell command.
+
+```bash
+pip install convilyn
+export CONVILYN_API_KEY=ck_...
+convilyn convert report.docx --to pdf
+```
+
+```python
+from convilyn import Convilyn
+
+client = Convilyn()  # reads CONVILYN_API_KEY from env
+file = client.files.upload("report.docx")
+job = client.convert.create_and_wait(file=file, target_format="pdf")
+client.convert.download_to(job, to="report.pdf")
+```
+
+## What you get
+
+* **Python SDK** — `Convilyn` (sync) and `AsyncConvilyn` (async) with
+  resource-style accessors: `client.files`, `client.convert`,
+  `client.goals` (agentic / AI workflows with HITL slot filling),
+  `client.workflows` (community marketplace), and `client.account`
+  (billing tier + cost-preview).
+
+  > **Goal progress is polling-only in v1.** Follow a run with
+  > `client.goals.wait(...)` / `retrieve(...)` (or `convilyn goals
+  > status` from the shell). The WebSocket gateway does not accept
+  > consumer `ck_` keys yet, so `goals.events()` streaming raises with
+  > guidance pointing back at polling until that lands.
+* **CLI** — five sub-command groups installed with the package:
+  * `convilyn convert <file> --to <format>` — upload, convert, download
+  * `convilyn doctor` — environment + connectivity diagnostics
+  * `convilyn api <METHOD> <PATH>` — gh-style escape hatch for any API endpoint
+  * `convilyn goals {start,status,events,fill-slot,confirm,cancel,retry}`
+    — drive AI workflows from the shell (NDJSON streaming, HITL,
+    pinned exit codes)
+  * `convilyn account {plan,quota}` — pre-flight your billing tier
+    and workflow cost before running
+* **Free to install, metered to use** — `pip install convilyn` is free.
+  API calls draw on your monthly quota (a generous free tier is
+  available; Pro lifts the cap). The SDK raises typed
+  `PlanRequiredError` / `QuotaExceededError` (both subclass `APIError`)
+  when an action exceeds your tier — see
+  [QUICKSTART §8](./QUICKSTART.md#8-check-your-plan--quota-before-running-clientaccount).
+* **Resilient by default** — retry on 5xx / 429 / 408
+  with exponential backoff + jitter, `Idempotency-Key` auto-stamped on
+  mutating verbs, `Retry-After` honoured.
+* **AI-agent friendly** — every command supports `--json` for
+  machine-readable output, `--dry-run` for safe previews, and pinned
+  exit codes (0 / 1 / 2 / 3 / 130) so agent loops can branch on the
+  result without parsing free-text.
+
+## Companion package — building your own workflows
+
+`convilyn` is the **consumer** SDK (you call the API). If you want to
+*build* a tool server or author a workflow spec for the Convilyn
+platform, install the **author** SDK:
+
+```bash
+pip install convilyn-author          # separate package
+convilyn-author init my-server
+```
+
+The two packages are intentionally separate so consumers don't pay
+the uvicorn / FastAPI dependency cost. See
+[`sdk/author-python`](https://github.com/CoreNovus/convilyn/tree/main/sdk/author-python)
+in the source repo.
+
+## Next
+
+* [QUICKSTART.md](./QUICKSTART.md) — 5-minute new-user guide (covers
+  convert, goals, workflows, and account / quota chapters)
+* [STABILITY.md](./STABILITY.md) — what the public API is and the
+  SemVer / deprecation promise behind it
+* [CHANGELOG.md](../CHANGELOG.md) — version history
+* [examples/](../examples/) — runnable Python + shell scripts
+* [AGENT.md](../AGENT.md) — guidance for AI coding agents
+  contributing to this SDK
+
+## Licence
+
+MIT. See [`LICENSE`](../LICENSE).