enterprise-rag-patterns 0.1.0__tar.gz

enterprise_rag_patterns-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ashutosh Rana
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

enterprise_rag_patterns-0.1.0/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: enterprise-rag-patterns
+Version: 0.1.0
+Summary: Reference patterns for compliance-aware retrieval-augmented workflows, context continuity, and governed AI integration in enterprise environments.
+Author: Ashutosh Rana
+License: MIT
+Project-URL: Homepage, https://github.com/ashutoshrana/enterprise-rag-patterns
+Project-URL: Issues, https://github.com/ashutoshrana/enterprise-rag-patterns/issues
+Project-URL: Changelog, https://github.com/ashutoshrana/enterprise-rag-patterns/blob/main/CHANGELOG.md
+Keywords: rag,retrieval-augmented-generation,ferpa,enterprise-ai,compliance,llm,higher-education,regulated-ai,agentic-ai,enterprise-patterns
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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 :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0; extra == "test"
+Provides-Extra: lint
+Requires-Dist: ruff>=0.4.0; extra == "lint"
+Provides-Extra: typecheck
+Requires-Dist: mypy>=1.0; extra == "typecheck"
+Provides-Extra: dev
+Requires-Dist: enterprise-rag-patterns[lint,test,typecheck]; extra == "dev"
+Dynamic: license-file
+
+# enterprise-rag-patterns
+
+[![CI](https://github.com/ashutoshrana/enterprise-rag-patterns/actions/workflows/ci.yml/badge.svg)](https://github.com/ashutoshrana/enterprise-rag-patterns/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
+[![PyPI](https://img.shields.io/pypi/v/enterprise-rag-patterns.svg)](https://pypi.org/project/enterprise-rag-patterns/)
+
+Practical reference patterns for retrieval-augmented workflows, context continuity, and governed AI integration in enterprise environments.
+
+## Why this repo exists
+
+Most examples of AI assistants stop at demo quality. Real enterprise systems have harder problems:
+- multiple source systems
+- fragmented context
+- workflow continuity across channels
+- compliance and audit requirements
+- human handoff only when it is actually needed
+
+This repository is a public-safe, anonymized scaffold for those patterns.
+
+## Pattern themes
+
+The examples in this repository are designed for teams building systems such as:
+- omnichannel service and enrollment workflows
+- multi-step document and verification processes
+- enterprise knowledge retrieval and action support
+- AI-assisted operations that require auditability and controlled human handoff
+
+## Scope
+
+This repo focuses on:
+- context assembly for AI workflows
+- session continuity across channels
+- human-in-loop escalation rules
+- enterprise-safe action boundaries
+- compliance and audit patterns for regulated environments (FERPA and similar frameworks)
+- reference architecture notes for operationally sensitive deployments
+
+The patterns are designed to be:
+- **Cloud-agnostic** — applicable on AWS, GCP, Azure, OCI, or hybrid environments
+- **Platform-agnostic** — not tied to any specific CRM, ERP, vector database, or LLM provider
+- **Regulation-aware** — compliance module targets FERPA; the same pattern applies to HIPAA, GLBA, and similar record-access frameworks
+
+It does not include customer data, institution-specific logic, or vendor-specific implementation artifacts.
+
+## Repository structure
+
+- `CONTRIBUTING.md`
+- `GOVERNANCE.md`
+- `CITATION.cff`
+- `docs/architecture.md`
+- `docs/implementation-note-01.md`
+- `docs/implementation-note-02.md` — FERPA boundaries in RAG
+- `docs/articles/`
+- `docs/adr/`
+- `docs/case-study-anonymized.md`
+- `examples/context-pipeline.yaml`
+- `examples/ferpa_rag_pipeline.py` — complete runnable FERPA-compliant pipeline
+- `src/enterprise_rag_patterns/`
+  - `context.py` — context envelope and source assembly
+  - `session.py` — cross-channel session continuity
+  - `policy.py` — escalation and action-boundary policy objects
+  - `compliance.py` — FERPA-aware context governance with audit logging
+
+## Why these patterns matter
+
+Enterprise AI systems usually fail at the seams:
+- between channels
+- between memory and policy
+- between the AI layer and the system-of-record
+
+The goal here is to make those seams explicit and reusable.
+
+## Modules
+
+- `context.py`
+  Context envelope and source assembly patterns.
+
+- `session.py`
+  Session memory and cross-channel continuity scaffolding.
+
+- `policy.py`
+  Escalation and action-boundary policy objects.
+
+- `compliance.py`
+  FERPA-aware context governance for regulated environments. Provides
+  `StudentIdentityScope` for defining retrieval boundaries, `FERPAContextPolicy`
+  for filtering retrieved documents before they enter the LLM context window,
+  and `AuditRecord` for 34 CFR § 99.32 disclosure logging.
+  See `docs/implementation-note-02.md` for design rationale and usage guidance.
+
+## Intended audience
+
+- enterprise architects
+- AI platform engineers
+- enterprise platform and workflow operators
+- applied AI teams working in regulated or multi-system environments
+
+## Public positioning
+
+This repo is meant to show practical architecture thinking, not marketing language.
+
+## Near-term roadmap
+
+- add architecture decision records for cross-channel continuity
+- publish a reference event flow for system-of-record synchronization
+- add policy examples for human escalation thresholds
+- document anonymized implementation lessons from production-style operating environments
+
+## Published notes
+
+- implementation note 01: [`docs/implementation-note-01.md`](./docs/implementation-note-01.md) — Cross-channel continuity problem and solution
+- implementation note 02: [`docs/implementation-note-02.md`](./docs/implementation-note-02.md) — FERPA boundaries in retrieval-augmented generation
+- article: [`docs/articles/production-grade-rag-in-regulated-enterprise-environments.md`](./docs/articles/production-grade-rag-in-regulated-enterprise-environments.md)
+
+## Project governance
+
+- contribution guidance: [`CONTRIBUTING.md`](./CONTRIBUTING.md)
+- governance model: [`GOVERNANCE.md`](./GOVERNANCE.md)
+- architecture decisions: [`docs/adr`](./docs/adr)
+- system overview: [`docs/architecture.md`](./docs/architecture.md)
+
+## Citing this work
+
+If you use these patterns in your work, see `CITATION.cff` or use GitHub's "Cite this repository" button above.
+
+## Status
+
+Active development. Current focus: compliance-aware RAG patterns for regulated enterprise environments, applicable across cloud providers and enterprise platforms.

enterprise_rag_patterns-0.1.0/README.md

@@ -0,0 +1,129 @@
+# enterprise-rag-patterns
+
+[![CI](https://github.com/ashutoshrana/enterprise-rag-patterns/actions/workflows/ci.yml/badge.svg)](https://github.com/ashutoshrana/enterprise-rag-patterns/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
+[![PyPI](https://img.shields.io/pypi/v/enterprise-rag-patterns.svg)](https://pypi.org/project/enterprise-rag-patterns/)
+
+Practical reference patterns for retrieval-augmented workflows, context continuity, and governed AI integration in enterprise environments.
+
+## Why this repo exists
+
+Most examples of AI assistants stop at demo quality. Real enterprise systems have harder problems:
+- multiple source systems
+- fragmented context
+- workflow continuity across channels
+- compliance and audit requirements
+- human handoff only when it is actually needed
+
+This repository is a public-safe, anonymized scaffold for those patterns.
+
+## Pattern themes
+
+The examples in this repository are designed for teams building systems such as:
+- omnichannel service and enrollment workflows
+- multi-step document and verification processes
+- enterprise knowledge retrieval and action support
+- AI-assisted operations that require auditability and controlled human handoff
+
+## Scope
+
+This repo focuses on:
+- context assembly for AI workflows
+- session continuity across channels
+- human-in-loop escalation rules
+- enterprise-safe action boundaries
+- compliance and audit patterns for regulated environments (FERPA and similar frameworks)
+- reference architecture notes for operationally sensitive deployments
+
+The patterns are designed to be:
+- **Cloud-agnostic** — applicable on AWS, GCP, Azure, OCI, or hybrid environments
+- **Platform-agnostic** — not tied to any specific CRM, ERP, vector database, or LLM provider
+- **Regulation-aware** — compliance module targets FERPA; the same pattern applies to HIPAA, GLBA, and similar record-access frameworks
+
+It does not include customer data, institution-specific logic, or vendor-specific implementation artifacts.
+
+## Repository structure
+
+- `CONTRIBUTING.md`
+- `GOVERNANCE.md`
+- `CITATION.cff`
+- `docs/architecture.md`
+- `docs/implementation-note-01.md`
+- `docs/implementation-note-02.md` — FERPA boundaries in RAG
+- `docs/articles/`
+- `docs/adr/`
+- `docs/case-study-anonymized.md`
+- `examples/context-pipeline.yaml`
+- `examples/ferpa_rag_pipeline.py` — complete runnable FERPA-compliant pipeline
+- `src/enterprise_rag_patterns/`
+  - `context.py` — context envelope and source assembly
+  - `session.py` — cross-channel session continuity
+  - `policy.py` — escalation and action-boundary policy objects
+  - `compliance.py` — FERPA-aware context governance with audit logging
+
+## Why these patterns matter
+
+Enterprise AI systems usually fail at the seams:
+- between channels
+- between memory and policy
+- between the AI layer and the system-of-record
+
+The goal here is to make those seams explicit and reusable.
+
+## Modules
+
+- `context.py`
+  Context envelope and source assembly patterns.
+
+- `session.py`
+  Session memory and cross-channel continuity scaffolding.
+
+- `policy.py`
+  Escalation and action-boundary policy objects.
+
+- `compliance.py`
+  FERPA-aware context governance for regulated environments. Provides
+  `StudentIdentityScope` for defining retrieval boundaries, `FERPAContextPolicy`
+  for filtering retrieved documents before they enter the LLM context window,
+  and `AuditRecord` for 34 CFR § 99.32 disclosure logging.
+  See `docs/implementation-note-02.md` for design rationale and usage guidance.
+
+## Intended audience
+
+- enterprise architects
+- AI platform engineers
+- enterprise platform and workflow operators
+- applied AI teams working in regulated or multi-system environments
+
+## Public positioning
+
+This repo is meant to show practical architecture thinking, not marketing language.
+
+## Near-term roadmap
+
+- add architecture decision records for cross-channel continuity
+- publish a reference event flow for system-of-record synchronization
+- add policy examples for human escalation thresholds
+- document anonymized implementation lessons from production-style operating environments
+
+## Published notes
+
+- implementation note 01: [`docs/implementation-note-01.md`](./docs/implementation-note-01.md) — Cross-channel continuity problem and solution
+- implementation note 02: [`docs/implementation-note-02.md`](./docs/implementation-note-02.md) — FERPA boundaries in retrieval-augmented generation
+- article: [`docs/articles/production-grade-rag-in-regulated-enterprise-environments.md`](./docs/articles/production-grade-rag-in-regulated-enterprise-environments.md)
+
+## Project governance
+
+- contribution guidance: [`CONTRIBUTING.md`](./CONTRIBUTING.md)
+- governance model: [`GOVERNANCE.md`](./GOVERNANCE.md)
+- architecture decisions: [`docs/adr`](./docs/adr)
+- system overview: [`docs/architecture.md`](./docs/architecture.md)
+
+## Citing this work
+
+If you use these patterns in your work, see `CITATION.cff` or use GitHub's "Cite this repository" button above.
+
+## Status
+
+Active development. Current focus: compliance-aware RAG patterns for regulated enterprise environments, applicable across cloud providers and enterprise platforms.

enterprise_rag_patterns-0.1.0/pyproject.toml

@@ -0,0 +1,73 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "enterprise-rag-patterns"
+version = "0.1.0"
+description = "Reference patterns for compliance-aware retrieval-augmented workflows, context continuity, and governed AI integration in enterprise environments."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [
+  { name = "Ashutosh Rana" }
+]
+keywords = [
+  "rag",
+  "retrieval-augmented-generation",
+  "ferpa",
+  "enterprise-ai",
+  "compliance",
+  "llm",
+  "higher-education",
+  "regulated-ai",
+  "agentic-ai",
+  "enterprise-patterns",
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/ashutoshrana/enterprise-rag-patterns"
+Issues = "https://github.com/ashutoshrana/enterprise-rag-patterns/issues"
+Changelog = "https://github.com/ashutoshrana/enterprise-rag-patterns/blob/main/CHANGELOG.md"
+
+[project.optional-dependencies]
+test = ["pytest>=7.0", "pytest-cov>=4.0"]
+lint = ["ruff>=0.4.0"]
+typecheck = ["mypy>=1.0"]
+dev = [
+  "enterprise-rag-patterns[test,lint,typecheck]",
+]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v --tb=short"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+ignore_missing_imports = true

enterprise_rag_patterns-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

enterprise_rag_patterns-0.1.0/src/enterprise_rag_patterns/__init__.py

@@ -0,0 +1,31 @@
+"""Reference patterns for enterprise retrieval and workflow-safe AI integration."""
+
+from .compliance import (
+    AuditRecord,
+    DisclosureReason,
+    FERPAContextPolicy,
+    RecordCategory,
+    StudentIdentityScope,
+    make_enrollment_advisor_policy,
+)
+from .context import ContextEnvelope, ContextSource
+from .policy import ActionPolicy, EscalationRule
+from .session import SessionState
+
+__all__ = [
+    # Compliance / FERPA
+    "AuditRecord",
+    "DisclosureReason",
+    "FERPAContextPolicy",
+    "RecordCategory",
+    "StudentIdentityScope",
+    "make_enrollment_advisor_policy",
+    # Context
+    "ContextEnvelope",
+    "ContextSource",
+    # Policy
+    "ActionPolicy",
+    "EscalationRule",
+    # Session
+    "SessionState",
+]