flowtraicer 0.9.0__tar.gz

flowtraicer-0.9.0/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    services:
+      postgres:
+        image: postgres:16-alpine
+        env:
+          POSTGRES_PASSWORD: xai
+          POSTGRES_DB: xai
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd "pg_isready -U postgres"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install
+        run: pip install -e ".[dev,postgres,extraction,litellm]"
+
+      - name: Lint
+        run: |
+          ruff check .
+          ruff format --check .
+
+      - name: Test (incl. Postgres backend)
+        env:
+          FT_TEST_PG_DSN: postgresql://postgres:xai@127.0.0.1:5432/xai
+        run: pytest

flowtraicer-0.9.0/.github/workflows/publish.yml

@@ -0,0 +1,77 @@
+name: Publish to PyPI
+
+# Publishes flowtraicer to PyPI when a GitHub Release is published.
+# Uses PyPI Trusted Publishing (OIDC) — no API token/secret is stored in the repo.
+#
+# One-time setup on PyPI (https://pypi.org/manage/account/publishing/):
+#   Add a "pending publisher" for project `flowtraicer` with:
+#     Owner: AlirezaShk   Repository: flowtraicer
+#     Workflow name: publish.yml   Environment: pypi
+# After the first successful publish, the project's trusted publisher is permanent.
+#
+# Release flow: bump `version` in pyproject.toml -> tag (e.g. v0.0.1) ->
+# create a GitHub Release for that tag. This workflow then builds & publishes.
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch: # allow a manual run (build artifacts; publish still gated by environment)
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build & test distributions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+
+      - name: Install (with test extras)
+        run: pip install -e ".[dev,extraction,litellm]"
+
+      - name: Sanity — lint, import, test
+        run: |
+          ruff check .
+          python -c "import ft; from ft.registry import REGISTER; from ft.llm import LLMClient; print('ft import OK')"
+          pytest -q
+
+      - name: Build sdist + wheel
+        run: |
+          python -m pip install --upgrade build
+          python -m build
+
+      - name: Check metadata renders on PyPI
+        run: |
+          python -m pip install --upgrade twine
+          twine check dist/*
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    # Only publish for an actual release event (not manual builds).
+    if: github.event_name == 'release'
+    environment:
+      name: pypi
+      url: https://pypi.org/p/flowtraicer
+    permissions:
+      id-token: write # OIDC token for Trusted Publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI (Trusted Publishing)
+        uses: pypa/gh-action-pypi-publish@release/v1

flowtraicer-0.9.0/.gitignore

@@ -0,0 +1,26 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+
+# Test / tooling
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Trace stores / local data
+*.sqlite
+*.sqlite3
+*.db
+data/
+
+# OS / editor
+.DS_Store
+.idea/
+.vscode/

flowtraicer-0.9.0/CHANGELOG.md

@@ -0,0 +1,64 @@
+# Changelog
+
+All notable changes to this project are documented here. The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project aims to follow
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html) once it reaches a public release.
+
+## [Unreleased]
+
+## [0.9.0] - 2026-06-24
+
+First public release. FlowTraicer maps, visualizes, monitors, debugs, logs, and audits the
+steps of an engagement between a user and an agentic AI system.
+
+### Added
+
+**Trace core**
+- `Engagement → Step → Event` model with per-step tools, per-step extraction, global-step
+  intent switches, and per-step / per-engagement token totals.
+- `TraceState` base graph-state declaring the conventional channels (`tool_calls`, `llm_calls`,
+  `events`, `extraction`) so nodes never redeclare them.
+
+**Storage**
+- Pluggable append-only `Store` with SQLite (default, zero-dependency), Redis Streams, and
+  Postgres (JSONB + `LISTEN/NOTIFY`) backends, plus live `subscribe` on all three.
+
+**LangGraph integration**
+- Auto-instrumentation: `run_instrumented` records node entry/exit, timing, tools, LLM calls,
+  extractions, and intent switches; `read_topology` reflects the compiled graph.
+- Drop-off tracking: `goal_nodes` mark journeys that never reached a goal as `ABANDONED` with
+  `dropped_at` set to the last step reached.
+
+**Workflow orchestration**
+- `Workflow` DSL over LangGraph (declare steps, tools, global steps, goals, edges) with an
+  injected per-step context (`ctx.llm`) that records token usage automatically.
+- **Build once, run many:** a `Workflow` compiles its graph once (cached); per-run dependencies
+  pass through `run(..., llm=…, deps=…)` and surface to nodes via `ctx.llm` / `ctx.deps`
+  (LangGraph `configurable` DI). Nodes no longer close over request state, so one workflow
+  instance serves every request without rebuilding/recompiling the graph.
+
+**LLM integration (provider-agnostic)**
+- `ft.llm.LLMClient` protocol (one async `acomplete` method) is the only contract `ctx.llm`
+  requires, so any provider/SDK can be plugged in. `LiteLLMClient` is the bundled, config-driven
+  implementation (one config → 100+ providers). See the README's "bring your own provider".
+- Instructor-powered per-step schema extraction (`ft.extraction`).
+- Global LLM-provider registry: `ft.registry.REGISTER.set_llm_provider(client)` sets one default
+  provider every workflow falls back to (resolution order: per-run `llm=` > `Workflow(llm=)` >
+  registry). Validates the client satisfies `LLMClient` and raises a descriptive `TypeError`
+  otherwise.
+- Global recorder for out-of-workflow LLM calls: `REGISTER.set_recorder(recorder)` +
+  `REGISTER.record_llm_usage(model, tokens=…, caller=…, metadata=…)` record token usage from
+  agent/LLM calls made outside a `Workflow` (chat, voice, extraction). Each becomes a small
+  self-contained engagement so it rolls up by model/caller. Fail-open; validated on registration.
+
+**Analytics, retention & audit**
+- Cross-engagement analytics: `funnel`, `journeys`, `group_by`.
+- Retention: `purge` / `RetentionPolicy` (completed engagements past their window; active ones
+  never purged).
+- Tamper-evident audit digests (`ft.audit`): fingerprint an engagement and later detect any
+  alteration.
+
+**Viewer**
+- FastAPI query + live-stream server and a linked Cytoscape.js **graph + timeline** viewer.
+
+> Pre-1.0: the public API may still change between minor versions.

flowtraicer-0.9.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,41 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a
+harassment-free experience for everyone, regardless of age, body size, visible or invisible
+disability, ethnicity, sex characteristics, gender identity and expression, level of
+experience, education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse,
+inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes
+- Focusing on what is best for the overall community
+
+Examples of unacceptable behavior:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the
+project maintainers. All complaints will be reviewed and investigated promptly and fairly.
+Maintainers are obligated to respect the privacy and security of the reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.1.

flowtraicer-0.9.0/CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing to FlowTraicer
+
+Thanks for your interest! `FlowTraicer` is a small, focused library — contributions that keep it
+that way (clear boundaries, tested, documented) are very welcome.
+
+> **Note:** `FlowTraicer` is a working name and will be renamed before the first public release. The
+> package imports as `FlowTraicer` today; if you reference it, expect a rename.
+
+## Development setup
+
+Requires Python ≥ 3.11.
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"                 # core + test/lint deps (includes fakeredis)
+# optional, depending on what you touch:
+pip install -e ".[extraction]"          # Instructor extraction
+pip install -e ".[litellm]"             # the LiteLLM client helper
+pip install -e ".[postgres]"            # the Postgres store backend
+```
+
+## Tests
+
+```bash
+pytest                                   # the full suite
+```
+
+- The **SQLite** and **Redis** store tests run offline (Redis via `fakeredis`).
+- The **Postgres** store tests are skipped unless `FT_TEST_PG_DSN` is set:
+
+  ```bash
+  docker run -d --name FlowTraicer-pg -e POSTGRES_PASSWORD=FlowTraicer -e POSTGRES_DB=FlowTraicer \
+    -p 5432:5432 postgres:16-alpine
+  FT_TEST_PG_DSN="postgresql://postgres:FlowTraicer@127.0.0.1:5432/FlowTraicer" pytest
+  ```
+
+- No test needs a network or an API key — LLM/provider calls are injected/stubbed.
+
+We use **TDD**: write a failing test first, then the minimal code to pass it. Every new
+function/method gets a test; behaviour changes get a test that fails before your change.
+
+## Lint & format
+
+```bash
+ruff check .
+ruff format .
+```
+
+CI runs `ruff check`, `ruff format --check`, and `pytest` (with a Postgres service) on every
+push and PR. Keep the build green.
+
+## Design principles
+
+- **The trace core is framework-agnostic.** Only `ft.langgraph_adapter` knows about
+  LangGraph; other engines should be added as adapters that call the recorder's emit API.
+- **Instrumentation is fail-open** — recording must never crash the observed agent.
+- **Small, well-bounded units** with clear interfaces. If a file is doing too much, split it.
+- Prefer relative imports inside the package (the name is provisional).
+
+See the [README](README.md) architecture table and `docs/` for the bigger picture.
+
+## Commits & PRs
+
+- Conventional-style messages help (`feat:`, `fix:`, `docs:`, `refactor:`, `test:`).
+- One logical change per PR; include tests and doc updates with the code.
+- By contributing, you agree your contributions are licensed under the project's
+  [Apache-2.0 License](LICENSE).
+
+## Code of conduct
+
+This project follows the [Contributor Covenant](CODE_OF_CONDUCT.md). Be kind.

flowtraicer-0.9.0/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 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 [yyyy] [name of copyright owner]
+
+   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.