pubkit 0.1.0__tar.gz

pubkit-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+.pubkit/
+__pycache__/
+*.egg-info/
+dist/
+build/
+.venv/
+.pytest_cache/
+.ruff_cache/

pubkit-0.1.0/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+Versioning is [semantic](https://semver.org/); adapters may change behaviour on
+a minor bump when a platform changes underneath them.
+
+## [0.1.0] — 2026-09-11
+
+First release. Extracted from a real, painful publishing run: a 15,000-word
+illustrated three-part series to Medium that surfaced 21 distinct failure modes,
+all catalogued in `docs/FAILURE-MODES.md`.
+
+### Added
+
+- **Post IR** — a canonical, platform-agnostic document model with a
+  content-addressed id used as the idempotency key everywhere.
+- **Capability negotiation** — adapters declare what they support; the planner
+  emits explicit, printable degradations. `pubkit plan` shows them before
+  anything is sent.
+- **Check pipeline** — placeholders, numeric assertions, cross-references,
+  number drift, assets, budget, structure. Pluggable via `pubkit.checks`.
+- **Verified chunked transport** — per-chunk rolling-hash verification, probed
+  size ceilings, single-member gzip.
+- **Browser adapter toolkit** — paste-based document replace with a block-count
+  assertion, reload-then-fingerprint verification, caption-anchored `File`
+  image insertion, Unicode-folding anchor resolution, tag-chip post-conditions.
+- **Adapters** — Medium, Substack (browser); X, Dev.to, Hashnode (API).
+- **Runner** — six resumable steps per (document, platform), sqlite state store,
+  two-phase publish for series, hash-pinned `--confirm` gate, per-platform rate
+  limiting and jittered retry.
+- **CLI** — `init`, `validate`, `plan`, `publish`, `status`, `platforms`,
+  `doctor`, `auth login|logout|list`.
+- **Workflows** — GitHub Actions examples and Airflow operators.
+- **Extension points** — `pubkit.adapters`, `pubkit.renderers`, `pubkit.checks`,
+  `pubkit.hooks`, plus per-platform transforms.
+
+### Known limitations
+
+- Browser adapter selectors will need patching when a platform redesigns its
+  editor. They are isolated in one `EditorSelectors` dataclass per adapter
+  precisely so that is a small change.
+- Table→image rendering requires the `render` extra; without it, tables degrade
+  to lists on platforms that lack table support.
+- X media upload uses the v1.1 endpoint, which is what the v2 API still
+  requires.

pubkit-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 reasonable and customary use in 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 choose to offer,
+      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 Arun Singh and the pubkit Authors
+
+   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.

pubkit-0.1.0/NOTICE

@@ -0,0 +1,7 @@
+pubkit
+Copyright 2026 Arun Singh and the pubkit Authors
+
+This product includes software developed at
+https://github.com/arunsingh/pubkit
+
+Licensed under the Apache License, Version 2.0.

pubkit-0.1.0/PKG-INFO

@@ -0,0 +1,291 @@
+Metadata-Version: 2.5
+Name: pubkit
+Version: 0.1.0
+Summary: Publish one source to many platforms, safely. Medium, Substack, X, Dev.to, Hashnode.
+Project-URL: Homepage, https://github.com/arunsingh/pubkit
+Project-URL: Issues, https://github.com/arunsingh/pubkit/issues
+Project-URL: Documentation, https://github.com/arunsingh/pubkit#readme
+Project-URL: Changelog, https://github.com/arunsingh/pubkit/blob/main/CHANGELOG.md
+Project-URL: Failure modes, https://github.com/arunsingh/pubkit/blob/main/docs/FAILURE-MODES.md
+Author: Arun Singh
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: automation,content,devto,hashnode,medium,publishing,substack,twitter,x
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.6
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.7
+Requires-Dist: typer>=0.12
+Provides-Extra: airflow
+Requires-Dist: apache-airflow>=2.9; extra == 'airflow'
+Provides-Extra: all
+Requires-Dist: cryptography>=42.0; extra == 'all'
+Requires-Dist: keyring>=25.0; extra == 'all'
+Requires-Dist: pillow>=10.0; extra == 'all'
+Requires-Dist: playwright>=1.44; extra == 'all'
+Provides-Extra: browser
+Requires-Dist: playwright>=1.44; extra == 'browser'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: keychain
+Requires-Dist: cryptography>=42.0; extra == 'keychain'
+Requires-Dist: keyring>=25.0; extra == 'keychain'
+Provides-Extra: render
+Requires-Dist: pillow>=10.0; extra == 'render'
+Description-Content-Type: text/markdown
+
+# pubkit
+
+**Publish one source to many platforms, safely.**
+Medium · Substack · X · Dev.to · Hashnode — and whatever you add next.
+
+[![PyPI](https://img.shields.io/pypi/v/pubkit.svg)](https://pypi.org/project/pubkit/)
+[![Python](https://img.shields.io/pypi/pyversions/pubkit.svg)](https://pypi.org/project/pubkit/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![CI](https://github.com/arunsingh/pubkit/actions/workflows/ci.yml/badge.svg)](https://github.com/arunsingh/pubkit/actions/workflows/ci.yml)
+
+---
+
+## Why this exists
+
+I published a 15,000-word, three-part illustrated series to Medium. It took far
+longer than writing it, and not for any reason I could have predicted.
+
+A 12,368-character payload arrived with exactly **one byte** changed, and
+nothing reported an error. Pasting a document replaced 2 of 169 paragraphs and
+silently appended the rest, producing a scrambled duplicate. A delete that
+visibly worked was back after a reload. Link hrefs set in the DOM reverted every
+time. Every image — `data:` URI and `https://` URL alike — was stripped out of
+pasted HTML, and it took eight dead ends to find the one insertion path that
+works. A scripted check of 32 numeric claims found 5 that were wrong, including
+two ratios transposed in an edit that no amount of re-reading had caught. And
+the automation bridge dropped eight times, so everything had to be re-runnable.
+
+None of that is Medium being unusual. It is what automating *any* rich-text
+editor looks like. pubkit is that knowledge, extracted and made reusable.
+
+[`docs/FAILURE-MODES.md`](docs/FAILURE-MODES.md) catalogues all of it — every
+entry names the component that answers it.
+
+## Install
+
+```bash
+pip install "pubkit[all]"
+playwright install chromium     # Medium and Substack only
+pubkit doctor                   # confirms your environment before you start
+```
+
+Thirty seconds to something real:
+
+```bash
+pubkit init my-blog && cd my-blog
+pubkit validate content/
+pubkit plan content/ --to medium,devto
+```
+
+## Use it
+
+```bash
+# 0. Scaffold a content repo that validates on the first try.
+pubkit init my-blog && cd my-blog
+
+# 1. Check the content. No network, no browser, no side effects.
+pubkit validate content/series/
+
+# 2. See exactly what each platform will get — including every degradation.
+pubkit plan content/series/ --to medium,devto,x
+
+# 3. Sign in. pubkit never accepts a password.
+pubkit auth login medium        # opens a window; you sign in; it keeps the session
+pubkit auth login devto         # API token → OS keychain
+
+# 4. Drafts everywhere. Safe to re-run; a dropped connection costs one step.
+pubkit publish content/series/ --to medium,devto,x
+
+# 5. Go live.
+pubkit publish content/series/ --to medium,devto,x --confirm
+```
+
+`plan` output on a real series:
+
+```
+medium: part-1 (bf9abfe78ce4)
+  · images_via_browser   4 image(s) uploaded through the editor's own paste path
+                         — remote URLs and data: URIs are stripped by this platform
+  · code_flattened       4 code block(s) lose syntax highlighting
+
+devto: part-1 (bf9abfe78ce4)
+  · tags_trimmed         keeping 4 of 5
+
+x: part-1 (bf9abfe78ce4)
+  · split_into_thread    promo thread: 12 posts — hook, key claims, link to the full article
+  · tags_trimmed         5 tag(s) dropped — platform has no tags
+```
+
+Nothing is a surprise at publish time. That is the whole design goal.
+
+## Write once
+
+````markdown
+---
+id: part-1
+title: "Inside AI Infrastructure, Part 1: The Hardware"
+subtitle: Why a GPU is fast, and why it turns out to be a memory problem.
+tags: [AI Infrastructure, GPU, SRE]
+series: {id: inside-ai, index: 1, of: 3}
+budget: {words: 3500}
+---
+
+# What is behind the box you type into
+
+<!-- pubkit:define nvlink = 900 -->
+<!-- pubkit:define pcie5 = 128 -->
+
+NVLink is 7× wider than PCIe Gen5. <!-- pubkit:assert 7x = nvlink/pcie5 ±10% -->
+
+| Model | FP16 size |
+| :--- | ---: |
+| 70B  | 140 GB |
+*What the weights actually cost*
+
+![memory layout](img/vram.gif)
+*Every token costs one full read of the model out of VRAM.*
+
+Continued in [Part 2](${series.part2.url}).
+````
+
+That one file becomes: a Medium draft with the table rendered as a styled image
+and the GIF uploaded through the editor's own path; a Dev.to article with a
+native table and a fenced code block; a 12-post promo thread on X with a link
+back. The cross-link resolves itself during a two-phase publish.
+
+## What it actually guards against
+
+| Guard | What it prevents |
+|---|---|
+| Hash-verified chunked transport | a silently corrupted payload |
+| Probed chunk ceiling | undocumented per-call size limits |
+| `replace_document()` with a block-count assert | a paste that appends instead of replacing |
+| Reload-then-fingerprint verification | edits the editor showed you but never saved |
+| Caption-anchored `File` paste | images stripped out of pasted HTML |
+| Unicode-folding anchor resolution | an em dash breaking a text match |
+| Tag-chip post-condition | one 40-character invalid tag instead of five good ones |
+| `pubkit:assert` arithmetic | a transposed ratio reaching print |
+| Two-phase series publish | `URL-PART-2` going live as a link |
+| Content-addressed state store | a re-run creating a second draft |
+| Plan hash + `--confirm` | publishing something other than what you reviewed |
+
+## Architecture in one paragraph
+
+A canonical **Post IR** sits between your source and every platform. Adapters
+declare **capabilities**; the planner intersects the two and emits explicit
+**degradations**. A **runner** executes six steps per (document, platform) —
+auth, draft, content, media, verify, publish — recording each in a sqlite state
+store so a re-run resumes rather than restarts. Browser adapters inherit a DOM
+toolkit that encodes everything above; API adapters inherit rate limiting and
+retries. [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) has the diagram.
+
+## Add a platform
+
+```python
+from pubkit.core.browser import BrowserAdapter, EditorSelectors
+from pubkit.core.capabilities import Capabilities
+
+class GhostAdapter(BrowserAdapter):
+    name = "ghost"
+    capabilities = Capabilities(tables=True, image_upload="browser_paste")
+    selectors = EditorSelectors(
+        editable=".koenig-editor__editor",
+        content_roots=".koenig-editor__editor",   # ALL roots, not the first
+        block="[data-kg='editor'] > *",
+        figure="figure", figure_img="figure img", link="a",
+        publish_button=".gh-publishmenu-trigger",
+    )
+    async def ensure_draft(self, doc, ctx): ...
+    async def publish(self, doc, ref, ctx): ...
+```
+
+Register it from your own package — no fork required:
+
+```toml
+[project.entry-points."pubkit.adapters"]
+ghost = "my_pubkit_ghost:GhostAdapter"
+```
+
+Five extension points, all first-class: `pubkit.adapters`, `pubkit.renderers`,
+`pubkit.checks`, `pubkit.hooks`, and per-platform `transforms:` in config.
+
+## Fit it into a workflow
+
+**GitHub Actions** — plan on every PR, publish on merge:
+
+```yaml
+- run: pubkit validate content/ --strict
+- run: pubkit plan content/ --to medium,devto >> $GITHUB_STEP_SUMMARY
+- run: pubkit publish content/ --to medium,devto --confirm
+  if: github.ref == 'refs/heads/main'
+  env:
+    PUBKIT_VAULT_KEY: ${{ secrets.PUBKIT_VAULT_KEY }}
+```
+
+**Airflow** — one task per (document, platform), so retries and alerting belong
+to Airflow:
+
+```python
+validate = PubkitValidateOperator(task_id="validate", path="content/series/")
+validate >> PubkitPublishOperator.expand_fanout(
+    path="content/series/", platforms=["medium", "devto", "x"], confirm=True,
+)
+```
+
+**Library** — `from pubkit import Pipeline` for everything else.
+
+## Security
+
+- **pubkit never accepts a password.** Browser platforms use an interactive
+  login you perform; pubkit persists only the session, encrypted at rest.
+- API tokens live in the OS keychain, or an encrypted vault for CI.
+- Secrets are stripped from logs by a filter, not by discipline.
+- Adapters receive credentials for their own platform and nothing else.
+- Every public write needs `--confirm`, against a hash-pinned plan.
+
+## Status
+
+v0.1. The core, the checks, the planner and the state machine are tested (32
+tests) and exercised end-to-end against a real published series in
+`examples/inside-ai-infra/`. The browser adapters encode techniques verified by
+hand against live editors; selectors are the part most likely to need a patch
+when a platform ships a redesign, which is exactly why they are isolated in one
+dataclass per adapter.
+
+## Docs
+
+| | |
+|---|---|
+| [QUICKSTART.md](docs/QUICKSTART.md) | five minutes, one platform |
+| [FAILURE-MODES.md](docs/FAILURE-MODES.md) | the 21 ways publishing quietly goes wrong |
+| [ARCHITECTURE.md](docs/ARCHITECTURE.md) | how it fits together |
+| [ADAPTERS.md](docs/ADAPTERS.md) | add a platform |
+| [SECURITY.md](SECURITY.md) | threat model and credential handling |
+
+Contributions welcome — especially new adapters and new checks. The one hard
+rule: a bug fix adds a row to `docs/FAILURE-MODES.md` and a test named after the
+failure. See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Licence
+
+Apache 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).