responseiq 1.3.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. responseiq-1.3.4/.gitignore +216 -0
  2. responseiq-1.3.4/LICENSE +21 -0
  3. responseiq-1.3.4/PKG-INFO +178 -0
  4. responseiq-1.3.4/README.md +131 -0
  5. responseiq-1.3.4/pyproject.toml +208 -0
  6. responseiq-1.3.4/src/responseiq/__init__.py +1 -0
  7. responseiq-1.3.4/src/responseiq/__version__.py +1 -0
  8. responseiq-1.3.4/src/responseiq/ai/__init__.py +0 -0
  9. responseiq-1.3.4/src/responseiq/ai/llm_service.py +86 -0
  10. responseiq-1.3.4/src/responseiq/ai/model_utils.py +0 -0
  11. responseiq-1.3.4/src/responseiq/app.py +144 -0
  12. responseiq-1.3.4/src/responseiq/blueprints/__init__.py +9 -0
  13. responseiq-1.3.4/src/responseiq/blueprints/crashloop_increase_memory.yml +28 -0
  14. responseiq-1.3.4/src/responseiq/blueprints/loader.py +54 -0
  15. responseiq-1.3.4/src/responseiq/cli.py +243 -0
  16. responseiq-1.3.4/src/responseiq/db.py +51 -0
  17. responseiq-1.3.4/src/responseiq/integrations/github_integration.py +43 -0
  18. responseiq-1.3.4/src/responseiq/models.py +25 -0
  19. responseiq-1.3.4/src/responseiq/parsers/__init__.py +4 -0
  20. responseiq-1.3.4/src/responseiq/parsers/base.py +19 -0
  21. responseiq-1.3.4/src/responseiq/parsers/custom_parser.py +88 -0
  22. responseiq-1.3.4/src/responseiq/parsers/registry.py +30 -0
  23. responseiq-1.3.4/src/responseiq/routers/blueprints.py +35 -0
  24. responseiq-1.3.4/src/responseiq/schemas/__init__.py +0 -0
  25. responseiq-1.3.4/src/responseiq/schemas/blueprint.py +29 -0
  26. responseiq-1.3.4/src/responseiq/schemas/incident.py +11 -0
  27. responseiq-1.3.4/src/responseiq/schemas/log.py +15 -0
  28. responseiq-1.3.4/src/responseiq/schemas/recommendation.py +0 -0
  29. responseiq-1.3.4/src/responseiq/schemas/user.py +0 -0
  30. responseiq-1.3.4/src/responseiq/services/__init__.py +0 -0
  31. responseiq-1.3.4/src/responseiq/services/analyzer.py +98 -0
  32. responseiq-1.3.4/src/responseiq/services/incident_service.py +43 -0
  33. responseiq-1.3.4/src/responseiq/services/notification_service.py +0 -0
  34. responseiq-1.3.4/src/responseiq/services/pr_service.py +84 -0
  35. responseiq-1.3.4/src/responseiq/services/remediation_service.py +45 -0
  36. responseiq-1.3.4/src/responseiq/static/blueprints.html +71 -0
  37. responseiq-1.3.4/src/responseiq/utils/__init__.py +0 -0
  38. responseiq-1.3.4/src/responseiq/utils/config_loader.py +143 -0
  39. responseiq-1.3.4/src/responseiq/utils/context_extractor.py +118 -0
  40. responseiq-1.3.4/src/responseiq/utils/data_validation.py +0 -0
  41. responseiq-1.3.4/src/responseiq/utils/git_utils.py +64 -0
  42. responseiq-1.3.4/src/responseiq/utils/k8s_patcher.py +76 -0
  43. responseiq-1.3.4/src/responseiq/utils/log_processor.py +115 -0
  44. responseiq-1.3.4/src/responseiq/utils/logger.py +35 -0
  45. responseiq-1.3.4/src/responseiq/utils/telemetry.py +45 -0
@@ -0,0 +1,216 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # UV
98
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ #uv.lock
102
+
103
+ # poetry
104
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
106
+ # commonly ignored for libraries.
107
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108
+ #poetry.lock
109
+ #poetry.toml
110
+
111
+ # pdm
112
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115
+ #pdm.lock
116
+ #pdm.toml
117
+ .pdm-python
118
+ .pdm-build/
119
+
120
+ # pixi
121
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122
+ #pixi.lock
123
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124
+ # in the .venv directory. It is recommended not to include this directory in version control.
125
+ .pixi
126
+
127
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128
+ __pypackages__/
129
+
130
+ # Celery stuff
131
+ celerybeat-schedule
132
+ celerybeat.pid
133
+
134
+ # SageMath parsed files
135
+ *.sage.py
136
+
137
+ # Environments
138
+ .env
139
+ .envrc
140
+ .venv
141
+ env/
142
+ venv/
143
+ ENV/
144
+ env.bak/
145
+ venv.bak/
146
+
147
+ # Spyder project settings
148
+ .spyderproject
149
+ .spyproject
150
+
151
+ # Rope project settings
152
+ .ropeproject
153
+
154
+ # mkdocs documentation
155
+ /site
156
+
157
+ # mypy
158
+ .mypy_cache/
159
+ .dmypy.json
160
+ dmypy.json
161
+
162
+ # Pyre type checker
163
+ .pyre/
164
+
165
+ # pytype static type analyzer
166
+ .pytype/
167
+
168
+ # Cython debug symbols
169
+ cython_debug/
170
+
171
+ # PyCharm
172
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
173
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
174
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
175
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
176
+ #.idea/
177
+
178
+ # Abstra
179
+ # Abstra is an AI-powered process automation framework.
180
+ # Ignore directories containing user credentials, local state, and settings.
181
+ # Learn more at https://abstra.io/docs
182
+ .abstra/
183
+
184
+ # Visual Studio Code
185
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
186
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
187
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
188
+ # you could uncomment the following to ignore the entire vscode folder
189
+ # .vscode/
190
+
191
+ # Ruff stuff:
192
+ .ruff_cache/
193
+
194
+ # PyPI configuration file
195
+ .pypirc
196
+
197
+ # Cursor
198
+ # Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
199
+ # exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
200
+ # refer to https://docs.cursor.com/context/ignore-files
201
+ .cursorignore
202
+ .cursorindexingignore
203
+
204
+ # Marimo
205
+ marimo/_static/
206
+ marimo/_lsp/
207
+ __marimo__/
208
+ *.db
209
+ system/
210
+
211
+ CHANGELOG.md
212
+ README_UV_Update.md
213
+ ResponseIQ_Design_Document.md
214
+
215
+ # AI Agents
216
+ .github/agents/
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Youth Innovations
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,178 @@
1
+ Metadata-Version: 2.4
2
+ Name: responseiq
3
+ Version: 1.3.4
4
+ Summary: AI-Powered Infrastructure Copilot: The Self-Healing SRE.
5
+ Project-URL: Homepage, https://github.com/infoyouth/responseiq
6
+ Project-URL: Repository, https://github.com/infoyouth/responseiq
7
+ Project-URL: Documentation, https://github.com/infoyouth/responseiq#readme
8
+ Project-URL: Bug Tracker, https://github.com/infoyouth/responseiq/issues
9
+ Project-URL: Changelog, https://github.com/infoyouth/responseiq/blob/main/CHANGELOG.md
10
+ Author-email: Youth Innovations <info.youthinno@gmail.com>
11
+ License-Expression: MIT
12
+ License-File: LICENSE
13
+ Keywords: ai-ops,devops,infrastructure-as-code,kubernetes,observability,platform-engineering,responseiq,self-healing,sre
14
+ Classifier: Development Status :: 4 - Beta
15
+ Classifier: Framework :: FastAPI
16
+ Classifier: Intended Audience :: Developers
17
+ Classifier: Intended Audience :: Information Technology
18
+ Classifier: Intended Audience :: System Administrators
19
+ Classifier: License :: OSI Approved :: MIT License
20
+ Classifier: Operating System :: OS Independent
21
+ Classifier: Programming Language :: Python :: 3.11
22
+ Classifier: Programming Language :: Python :: 3.12
23
+ Classifier: Topic :: Software Development :: Debuggers
24
+ Classifier: Topic :: System :: Monitoring
25
+ Classifier: Topic :: System :: Systems Administration
26
+ Requires-Python: >=3.11
27
+ Requires-Dist: aiofiles>=23.0.0
28
+ Requires-Dist: fastapi>=0.100.0
29
+ Requires-Dist: httpx>=0.24.0
30
+ Requires-Dist: loguru>=0.7.0
31
+ Requires-Dist: opentelemetry-api>=1.15.0
32
+ Requires-Dist: opentelemetry-exporter-jaeger>=1.15.0
33
+ Requires-Dist: opentelemetry-exporter-otlp>=1.15.0
34
+ Requires-Dist: opentelemetry-instrumentation-fastapi>=0.36b0
35
+ Requires-Dist: opentelemetry-instrumentation-logging>=0.36b0
36
+ Requires-Dist: opentelemetry-instrumentation>=0.36b0
37
+ Requires-Dist: opentelemetry-sdk>=1.15.0
38
+ Requires-Dist: psycopg2-binary>=2.9.0
39
+ Requires-Dist: pydantic-settings>=2.0.0
40
+ Requires-Dist: pydantic>=2.0.0
41
+ Requires-Dist: pygithub>=1.59.0
42
+ Requires-Dist: ruamel-yaml>=0.17.0
43
+ Requires-Dist: slack-sdk>=3.20.0
44
+ Requires-Dist: sqlmodel>=0.0.8
45
+ Requires-Dist: uvicorn>=0.20.0
46
+ Description-Content-Type: text/markdown
47
+
48
+ # ResponseIQ
49
+
50
+ [![CI](https://github.com/infoyouth/responseiq/actions/workflows/ci.yml/badge.svg)](https://github.com/infoyouth/responseiq/actions)
51
+ [![GitHub Release](https://img.shields.io/github/v/release/infoyouth/responseiq)](https://github.com/infoyouth/responseiq/releases)
52
+ [![PyPI](https://img.shields.io/pypi/v/responseiq)](https://pypi.org/project/responseiq/)
53
+ [![License](https://img.shields.io/github/license/infoyouth/responseiq)](LICENSE)
54
+ [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
55
+ [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
56
+
57
+ > **"Don't just debug. Fix."**
58
+
59
+ **ResponseIQ** is an AI-Native **Self-Healing Infrastructure Copilot**.
60
+ Unlike traditional parsers that match regex strings, ResponseIQ reads your application logs, **loads your actual source code into an LLM context**, and generates surgical, context-aware remediation patches for incidents.
61
+
62
+ ---
63
+
64
+ ## 📸 See It In Action
65
+
66
+ ![ResponseIQ CLI Demo](docs/assets/demo_placeholder.gif)
67
+
68
+ *Above: ResponseIQ scanning a crash log, reading the `service.py` file mentioned in the stack trace, and proposing a specific code patch.*
69
+
70
+ ---
71
+
72
+ ## ✨ Key Features
73
+
74
+ - **🧠 AI-Native Analysis**: Uses Generic AI reasoning instead of fragile regex parsing rules.
75
+ - **👁️ Context-Aware**: Reads the local source files referenced in logs to understand *why* the crash happened.
76
+ - **⚡ Self-Healing**: Can generate Pull Requests or apply patches directly (CLI mode).
77
+ - **🛡️ Battle-Tested**: Includes "Sandbox Mode" to safely test remediation logic.
78
+
79
+ ---
80
+
81
+ ## 🚀 Quick Start (CLI Tool)
82
+
83
+ For developers who want to fix bugs in their local environment or CI pipeline.
84
+
85
+ ### 1. Install
86
+ ```bash
87
+ pip install responseiq
88
+ ```
89
+
90
+ ### 2. Configure Credentials
91
+ ResponseIQ requires access to an LLM provider to reason about your code.
92
+
93
+ *Currently supported: OpenAI*
94
+
95
+ ```bash
96
+ export OPENAI_API_KEY="sk-..."
97
+ ```
98
+
99
+ ### 3. Usage Examples
100
+
101
+ **Example A: Analyze Local Logs**
102
+ Scan a directory of log files and get a report of active incidents.
103
+ ```bash
104
+ responseiq --mode scan --target ./var/log/app/
105
+ ```
106
+
107
+ **Example B: The "Magic Fix"**
108
+ Analyze logs AND the current source code to generate a patch.
109
+ ```bash
110
+ # Finds errors in logs, locates the source file, and explains the fix
111
+ responseiq --mode fix --target ./logs/error.log
112
+ ```
113
+
114
+ **Example C: CI/CD Pipeline Integration**
115
+ Run ResponseIQ as a step in your GitHub Action to auto-triage build failures.
116
+ ```bash
117
+ # In your workflow
118
+ responseiq --mode scan --target ./build_logs.txt >> summary.md
119
+ ```
120
+
121
+ ---
122
+
123
+ ## 🏢 Platform Server (Self-Hosted)
124
+
125
+ For Platform Engineers who want to host a centralized incident response API (Webhook receiver for Datadog, PagerDuty, etc.).
126
+
127
+ ### Prerequisites
128
+ - Docker & Docker Compose
129
+ - OpenAI API Key configured in `.env`
130
+
131
+ ### Running with Docker
132
+ ```bash
133
+ # 1. Start the API and Database
134
+ docker-compose up -d
135
+
136
+ # 2. The API is now available at http://localhost:8000
137
+ curl http://localhost:8000/health
138
+ ```
139
+
140
+ ### Development Setup (Local)
141
+ We use [UV](https://github.com/astral-sh/uv) for lightning-fast dependency management.
142
+
143
+ ```bash
144
+ # Install dependencies
145
+ uv sync
146
+
147
+ # Run the API server with hot-reload
148
+ uv run uvicorn src.app:app --reload
149
+ ```
150
+
151
+ ---
152
+
153
+ ## 🧪 Development & Contributing
154
+
155
+ ### Workflow
156
+ 1. **Linting**: `make lint`
157
+ 2. **Testing**: `make test`
158
+ 3. **Format**: `make format`
159
+
160
+ ### Project Structure
161
+ * `src/cli.py`: Entry point for the CLI tool.
162
+ * `src/app.py`: Entry point for the API Server.
163
+ * `src/services/remediation_service.py`: The core "Brain" that interfaces with the LLM.
164
+
165
+ ### License
166
+ MIT
167
+
168
+ ---
169
+
170
+ ## ⚠️ Disclaimer & Liability
171
+
172
+ This tool uses **Generative AI** to suggest infrastructure and code fixes.
173
+ By using ResponseIQ, you acknowledge that:
174
+ 1. **AI Can Hallucinate:** The suggestions provided may be syntactically correct but functionally wrong or insecure.
175
+ 2. **Human Review is Mandatory:** You must strictly review all Pull Requests or patches generated by this tool before deploying them.
176
+ 3. **No Warranty:** As per the [MIT License](LICENSE), the authors assume **no liability** for system outages, data loss, or security vulnerabilities resulting from the use of this software.
177
+
178
+ *For security reporting instructions, please see [SECURITY.md](docs/SECURITY.md).*
@@ -0,0 +1,131 @@
1
+ # ResponseIQ
2
+
3
+ [![CI](https://github.com/infoyouth/responseiq/actions/workflows/ci.yml/badge.svg)](https://github.com/infoyouth/responseiq/actions)
4
+ [![GitHub Release](https://img.shields.io/github/v/release/infoyouth/responseiq)](https://github.com/infoyouth/responseiq/releases)
5
+ [![PyPI](https://img.shields.io/pypi/v/responseiq)](https://pypi.org/project/responseiq/)
6
+ [![License](https://img.shields.io/github/license/infoyouth/responseiq)](LICENSE)
7
+ [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
8
+ [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
9
+
10
+ > **"Don't just debug. Fix."**
11
+
12
+ **ResponseIQ** is an AI-Native **Self-Healing Infrastructure Copilot**.
13
+ Unlike traditional parsers that match regex strings, ResponseIQ reads your application logs, **loads your actual source code into an LLM context**, and generates surgical, context-aware remediation patches for incidents.
14
+
15
+ ---
16
+
17
+ ## 📸 See It In Action
18
+
19
+ ![ResponseIQ CLI Demo](docs/assets/demo_placeholder.gif)
20
+
21
+ *Above: ResponseIQ scanning a crash log, reading the `service.py` file mentioned in the stack trace, and proposing a specific code patch.*
22
+
23
+ ---
24
+
25
+ ## ✨ Key Features
26
+
27
+ - **🧠 AI-Native Analysis**: Uses Generic AI reasoning instead of fragile regex parsing rules.
28
+ - **👁️ Context-Aware**: Reads the local source files referenced in logs to understand *why* the crash happened.
29
+ - **⚡ Self-Healing**: Can generate Pull Requests or apply patches directly (CLI mode).
30
+ - **🛡️ Battle-Tested**: Includes "Sandbox Mode" to safely test remediation logic.
31
+
32
+ ---
33
+
34
+ ## 🚀 Quick Start (CLI Tool)
35
+
36
+ For developers who want to fix bugs in their local environment or CI pipeline.
37
+
38
+ ### 1. Install
39
+ ```bash
40
+ pip install responseiq
41
+ ```
42
+
43
+ ### 2. Configure Credentials
44
+ ResponseIQ requires access to an LLM provider to reason about your code.
45
+
46
+ *Currently supported: OpenAI*
47
+
48
+ ```bash
49
+ export OPENAI_API_KEY="sk-..."
50
+ ```
51
+
52
+ ### 3. Usage Examples
53
+
54
+ **Example A: Analyze Local Logs**
55
+ Scan a directory of log files and get a report of active incidents.
56
+ ```bash
57
+ responseiq --mode scan --target ./var/log/app/
58
+ ```
59
+
60
+ **Example B: The "Magic Fix"**
61
+ Analyze logs AND the current source code to generate a patch.
62
+ ```bash
63
+ # Finds errors in logs, locates the source file, and explains the fix
64
+ responseiq --mode fix --target ./logs/error.log
65
+ ```
66
+
67
+ **Example C: CI/CD Pipeline Integration**
68
+ Run ResponseIQ as a step in your GitHub Action to auto-triage build failures.
69
+ ```bash
70
+ # In your workflow
71
+ responseiq --mode scan --target ./build_logs.txt >> summary.md
72
+ ```
73
+
74
+ ---
75
+
76
+ ## 🏢 Platform Server (Self-Hosted)
77
+
78
+ For Platform Engineers who want to host a centralized incident response API (Webhook receiver for Datadog, PagerDuty, etc.).
79
+
80
+ ### Prerequisites
81
+ - Docker & Docker Compose
82
+ - OpenAI API Key configured in `.env`
83
+
84
+ ### Running with Docker
85
+ ```bash
86
+ # 1. Start the API and Database
87
+ docker-compose up -d
88
+
89
+ # 2. The API is now available at http://localhost:8000
90
+ curl http://localhost:8000/health
91
+ ```
92
+
93
+ ### Development Setup (Local)
94
+ We use [UV](https://github.com/astral-sh/uv) for lightning-fast dependency management.
95
+
96
+ ```bash
97
+ # Install dependencies
98
+ uv sync
99
+
100
+ # Run the API server with hot-reload
101
+ uv run uvicorn src.app:app --reload
102
+ ```
103
+
104
+ ---
105
+
106
+ ## 🧪 Development & Contributing
107
+
108
+ ### Workflow
109
+ 1. **Linting**: `make lint`
110
+ 2. **Testing**: `make test`
111
+ 3. **Format**: `make format`
112
+
113
+ ### Project Structure
114
+ * `src/cli.py`: Entry point for the CLI tool.
115
+ * `src/app.py`: Entry point for the API Server.
116
+ * `src/services/remediation_service.py`: The core "Brain" that interfaces with the LLM.
117
+
118
+ ### License
119
+ MIT
120
+
121
+ ---
122
+
123
+ ## ⚠️ Disclaimer & Liability
124
+
125
+ This tool uses **Generative AI** to suggest infrastructure and code fixes.
126
+ By using ResponseIQ, you acknowledge that:
127
+ 1. **AI Can Hallucinate:** The suggestions provided may be syntactically correct but functionally wrong or insecure.
128
+ 2. **Human Review is Mandatory:** You must strictly review all Pull Requests or patches generated by this tool before deploying them.
129
+ 3. **No Warranty:** As per the [MIT License](LICENSE), the authors assume **no liability** for system outages, data loss, or security vulnerabilities resulting from the use of this software.
130
+
131
+ *For security reporting instructions, please see [SECURITY.md](docs/SECURITY.md).*