supafly 0.1.0__tar.gz

supafly-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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 the 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 any 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
+
+   Copyright 2026 aaftabskillgigs
+
+   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.

supafly-0.1.0/PKG-INFO

@@ -0,0 +1,289 @@
+Metadata-Version: 2.4
+Name: supafly
+Version: 0.1.0
+Summary: Portable context for AI coding agents. Write once in .supafly/, sync to Claude Code, Codex, Cursor, and more.
+Author: aaftabskillgigs
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/aaftabskillgigs/supafly
+Project-URL: Repository, https://github.com/aaftabskillgigs/supafly
+Project-URL: Issues, https://github.com/aaftabskillgigs/supafly/issues
+Keywords: ai,agents,context,claude,cursor,codex,copilot,developer-tools
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: textual>=0.61.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# Supafly
+
+Portable context for AI agents. BYOM = Bring Your Own Memory.
+
+Write your project context once in `.supafly/`. Supafly compiles it into the native format for every AI coding tool.
+
+```text
+.supafly/                        canonical source
+    |
+    v
+supafly sync
+    |
+    +--> CLAUDE.md               Claude Code
+    +--> .claude/rules/*.md      Claude Code (scoped)
+    +--> AGENTS.md               Codex
+    +--> .cursor/rules/*.mdc     Cursor
+    +--> .windsurf/rules/*.md    Windsurf (planned)
+    +--> .github/copilot-instructions.md  Copilot (planned)
+```
+
+## Install
+
+```bash
+pip install -e .
+```
+
+## Quick Start
+
+```bash
+supafly init                   # creates .supafly/ with starter templates
+supafly sync                   # renders target files from .supafly/
+supafly diff                   # preview what would change
+supafly validate               # lint config and frontmatter
+supafly sync --check           # exit non-zero if outputs are stale (for CI)
+supafly init --hook            # install a git pre-commit hook
+```
+
+## Run Locally (dev)
+
+```bash
+PYTHONPATH=src python3 -m supafly
+```
+
+---
+
+## Top 10 Practical Examples
+
+### 1. New Developer Onboarding — Zero Config
+
+You join a team. Clone the repo. Open Claude Code, Cursor, or Codex. Context is already there — no one has to explain "read the wiki" or "check the CLAUDE.md".
+
+```
+git clone repo
+cd repo
+# .supafly/ already synced -> CLAUDE.md, AGENTS.md, .cursor/rules/ all present
+# Every AI tool knows the stack, conventions, and current priorities on first prompt
+```
+
+### 2. Multi-Tool Team — One Source of Truth
+
+Your team has 3 devs on Cursor, 2 on Claude Code, 1 on Codex. Instead of maintaining 3 separate instruction files that drift apart, everyone edits `.supafly/`:
+
+```
+.supafly/project.md      <- "We use Next.js 14, pnpm, Postgres"
+.supafly/rule-testing.md  <- "Always use vitest, no jest"
+
+supafly sync ->
+  CLAUDE.md              (claude dev sees the rules)
+  AGENTS.md              (codex dev sees the rules)
+  .cursor/rules/*.mdc    (cursor devs see the rules)
+```
+
+One edit, all tools updated.
+
+### 3. Feature Freeze Announcement
+
+Product says "freeze all non-critical work until release". You add one file and every agent on the team knows:
+
+```yaml
+# .supafly/current-focus.md
+---
+kind: instruction
+title: Current Focus
+priority: high
+targets:
+  - claude
+  - codex
+  - cursor
+---
+FEATURE FREEZE until April 18. Bug fixes only.
+Do not introduce new dependencies or refactor existing code.
+```
+
+`supafly sync` — now every AI tool on the team refuses to build new features.
+
+### 4. Scoped Rules for Monorepos
+
+Frontend and backend live in the same repo but have different conventions. Use `scopes` so each agent only gets relevant rules in context:
+
+```yaml
+# .supafly/rule-frontend.md
+---
+kind: instruction
+title: Frontend Rules
+scopes:
+  - "src/web/**/*.tsx"
+targets:
+  - claude
+  - cursor
+---
+Use functional components. Tailwind only. No CSS modules.
+```
+
+```yaml
+# .supafly/rule-backend.md
+---
+kind: instruction
+title: Backend Rules
+scopes:
+  - "src/api/**/*.py"
+targets:
+  - claude
+  - codex
+---
+Use FastAPI. All endpoints need OpenAPI docstrings. No ORM — raw SQL only.
+```
+
+Claude Code gets scoped `.claude/rules/rule-frontend.md` and `.claude/rules/rule-backend.md`. Cursor gets `.cursor/rules/rule-frontend.mdc` with `globs: ["src/web/**/*.tsx"]`.
+
+### 5. CI Gate — Stale Context Detection
+
+Add a CI check so PRs can't merge if someone edited `.supafly/` but forgot to run sync:
+
+```yaml
+# .github/workflows/supafly.yml
+- name: Check context is current
+  run: supafly sync --check
+```
+
+Or locally via the pre-commit hook:
+
+```bash
+supafly init --hook
+# Now every commit runs supafly sync --check
+# Fails if generated files are out of date
+```
+
+### 6. Architecture Decision Records
+
+Your team decides to migrate from REST to GraphQL. Record it so every agent respects the decision going forward:
+
+```yaml
+# .supafly/decision-graphql-migration.md
+---
+kind: decision
+title: GraphQL Migration
+description: Moving public API from REST to GraphQL
+priority: high
+targets:
+  - claude
+  - codex
+  - cursor
+---
+As of April 2026, all new public endpoints must use GraphQL.
+Existing REST endpoints remain until client migration is complete.
+Do not add new REST routes under /api/v2/.
+```
+
+Every agent now knows the boundary — no one accidentally scaffolds a new REST endpoint.
+
+### 7. Switching AI Tools Without Losing Context
+
+You've been using Cursor for 6 months with detailed `.cursorrules`. Now you want to try Claude Code. Without Supafly, you'd manually rewrite everything into `CLAUDE.md`. With Supafly:
+
+```bash
+supafly import cursor          # pulls .cursorrules into .supafly/
+supafly sync                   # generates CLAUDE.md from the same source
+# Now both tools have identical context
+```
+
+### 8. Per-Developer Local Notes
+
+You have personal shortcuts, environment quirks, or scratch context that shouldn't be shared. Use `.supafly/local/`:
+
+```yaml
+# .supafly/local/identity.md
+---
+kind: note
+title: My Setup
+priority: low
+---
+I run on M4 Max. My local Postgres is on port 5433 not 5432.
+When I say "run tests" I mean the fast suite, not the integration tests.
+```
+
+This stays gitignored but still renders into your local agent context.
+
+### 9. Open Source Project — Contributor Agent Guidance
+
+You maintain an open source library. Contributors use different AI tools. Add `.supafly/` to your repo and every contributor's agent immediately knows:
+
+```yaml
+# .supafly/rule-general.md
+---
+kind: instruction
+title: Contribution Rules
+priority: high
+targets:
+  - claude
+  - codex
+  - cursor
+---
+- All PRs need tests
+- Use conventional commits (feat:, fix:, docs:)
+- No breaking changes without an RFC
+- Run `make lint` before submitting
+- Target Python 3.11+
+```
+
+No more PRs where the AI ignored your test requirements because the contributor didn't set up their tool.
+
+### 10. Handoff Notes Between Sessions
+
+You're halfway through a refactor and need to pick it up tomorrow. Leave a breadcrumb:
+
+```yaml
+# .supafly/session-handoff.md
+---
+kind: session
+title: Auth Refactor Handoff
+description: State of the auth middleware rewrite
+priority: high
+targets:
+  - claude
+  - codex
+---
+## What's done
+- Extracted token validation into auth/validator.py
+- All routes in /api/admin/* use the new middleware
+
+## What's left
+- /api/public/* still uses the old middleware
+- Tests in test_auth.py need updating for the new response format
+- Do NOT touch auth/legacy.py — it's load-bearing until public routes migrate
+```
+
+Next session, your agent starts with full context on where you left off.
+
+---
+
+## The Common Thread
+
+Supafly turns "agent context" from a per-tool, per-person artifact into a shared, version-controlled, portable project resource. Write it once in `.supafly/`, and every tool on every machine gets it.
+
+---
+
+## Current Status
+
+- Renderers: Claude Code, Codex, Cursor
+- CLI: init, sync, diff, validate, sync --check, init --hook
+- TUI: Textual app shell with workspace inspection