coderag-ai 0.3.0__tar.gz

coderag_ai-0.3.0/.env.example

@@ -0,0 +1,55 @@
+# Copy to .env and adjust. All variables are prefixed CODERAG_.
+# Retrieval (index/search/context) works with ONLY the database configured.
+# Only `coderag ask` needs an LLM provider.
+
+# ---- Database -------------------------------------------------------------
+CODERAG_DATABASE_URL=postgresql+psycopg://coderag:coderag@localhost:5432/coderag
+CODERAG_DB_ECHO=false
+
+# ---- Embeddings (run locally; source code never leaves your infra) --------
+# hashing = deterministic/offline default; sentence_transformer = local ST model.
+CODERAG_EMBEDDING_PROVIDER=hashing
+CODERAG_EMBEDDING_MODEL=sentence-transformers/all-MiniLM-L6-v2
+CODERAG_EMBEDDING_DEVICE=cpu
+CODERAG_EMBEDDING_BATCH_SIZE=32
+CODERAG_EMBEDDING_DIMENSION=384
+
+# ---- Token counting -------------------------------------------------------
+CODERAG_TOKEN_COUNTER=heuristic   # or: tiktoken (needs the `tokens` extra)
+
+# ---- Retrieval / fusion (ranking config lives here, not in code) ----------
+CODERAG_RRF_K=60
+CODERAG_WEIGHT_SYMBOL=2.0
+CODERAG_WEIGHT_LEXICAL=1.0
+CODERAG_WEIGHT_SEMANTIC=1.0
+CODERAG_WEIGHT_GRAPH=0.7
+CODERAG_MAX_CANDIDATES=60
+
+# ---- Graph expansion (bounded) --------------------------------------------
+CODERAG_GRAPH_ENABLED=true
+CODERAG_GRAPH_MAX_DEPTH=1
+CODERAG_GRAPH_MAX_CANDIDATES=20
+CODERAG_GRAPH_MAX_TOKENS=6000
+
+# ---- Reranking (optional; adds latency) -----------------------------------
+CODERAG_RERANKER_ENABLED=false
+CODERAG_RERANKER_MODEL=cross-encoder/ms-marco-MiniLM-L-6-v2
+
+# ---- Context builder ------------------------------------------------------
+CODERAG_MAX_CONTEXT_TOKENS=12000
+CODERAG_CONTEXT_OVERHEAD_TOKENS=600
+
+# ---- LLM provider (only needed for `ask`) ---------------------------------
+CODERAG_LLM_PROVIDER=anthropic          # or: null
+CODERAG_ANTHROPIC_API_KEY=
+CODERAG_ANTHROPIC_BASE_URL=https://api.anthropic.com
+CODERAG_ANTHROPIC_MODEL=claude-sonnet-5
+CODERAG_LLM_MAX_OUTPUT_TOKENS=1024
+
+# ---- Analyzers (Phase 10) -------------------------------------------------
+CODERAG_MAX_FIX_ATTEMPTS=2
+
+# ---- Security -------------------------------------------------------------
+# Comma-separated extra path fragments to ignore during indexing.
+CODERAG_EXTRA_IGNORE=
+CODERAG_LOG_CODE_SNIPPETS=false

coderag_ai-0.3.0/.gitignore

@@ -0,0 +1,31 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+.venv-*/
+venv/
+
+# Tooling
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+
+# Env / secrets — never commit real credentials
+.env
+*.local
+
+# OS
+.DS_Store
+
+# Model / data caches
+.cache/
+*.log
+
+# Scratch
+scratchpad/

coderag_ai-0.3.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,31 @@
+# Contributor Covenant 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 include demonstrating
+empathy and kindness, being respectful of differing opinions, giving and gracefully
+accepting constructive feedback, and focusing on what is best for the community.
+
+Unacceptable behavior includes harassment, trolling, insulting or derogatory comments,
+publishing others' private information without permission, and 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.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1.
+
+[homepage]: https://www.contributor-covenant.org

coderag_ai-0.3.0/CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Contributing to CodeRAG
+
+Thanks for your interest! CodeRAG is Apache-2.0 licensed and built to be extended.
+
+## Development setup
+
+```bash
+make install     # venv + dev deps (includes pgserver, so no Docker needed for tests)
+make migrate     # apply migrations (needs a running Postgres; see docker-compose.yml)
+make test        # full suite (spins up a rootless pgserver automatically)
+make lint typecheck
+```
+
+Tests use [`pgserver`](https://pypi.org/project/pgserver/), which bundles a PostgreSQL
+build with pgvector and runs without root or Docker. `@pytest.mark.db` marks tests that
+need it; `make test-fast` skips them.
+
+## Ground rules
+
+- **Every change ships with tests.** No `pass`/`TODO`/`return []` stubs except declared,
+  interface-only extension points.
+- **Run `make lint typecheck test` before opening a PR.**
+- **Security:** never log full source code, prompts, secrets, or credentials. Keep all
+  retrieval queries scoped by `repository_id`. See [`SECURITY.md`](SECURITY.md).
+- **No proprietary code.** Do not copy from Sourcegraph, Cursor, Cody, or similar. Build on
+  public/OSS libraries only.
+- **Configuration over constants.** Ranking weights and budgets live in
+  `coderag.core.config.Settings`, not scattered literals.
+
+## Extending
+
+- New language parser → implement `coderag.parsing.base.LanguageParser`; see
+  [`docs/adding-language.md`](docs/adding-language.md).
+- New LLM transport → implement `coderag.llm.base.LLMProvider`; see
+  [`docs/llm-providers.md`](docs/llm-providers.md).
+- New embedding model → implement `coderag.embeddings.base.EmbeddingProvider`.
+
+## Commit / PR conventions
+
+Small, focused commits. Reference the phase or ADR where relevant. Describe *why*, not just
+*what*.

coderag_ai-0.3.0/Dockerfile

@@ -0,0 +1,27 @@
+# CodeRAG API + CLI image.
+# Base install only (no torch); enable local embeddings with the `embeddings` extra
+# by changing the pip line to `pip install -e ".[embeddings]"` if you want on-box
+# SentenceTransformers.
+FROM python:3.12-slim AS base
+
+ENV PYTHONUNBUFFERED=1 \
+    PIP_NO_CACHE_DIR=1 \
+    PYTHONDONTWRITEBYTECODE=1
+
+# git is needed for repository ingestion (enumeration + diff).
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends git \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+COPY pyproject.toml README.md LICENSE alembic.ini ./
+COPY src ./src
+RUN pip install --upgrade pip && pip install -e .
+
+# bundled demo repo (for the optional one-shot demo index) + startup script
+COPY examples ./examples
+COPY docker/entrypoint.sh ./docker/entrypoint.sh
+RUN chmod +x ./docker/entrypoint.sh
+
+EXPOSE 8000
+ENTRYPOINT ["./docker/entrypoint.sh"]

coderag_ai-0.3.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 [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.

coderag_ai-0.3.0/Makefile

@@ -0,0 +1,55 @@
+.PHONY: help install migrate revision test test-fast lint fmt typecheck run demo clean
+
+VENV ?= .venv
+PY := $(VENV)/bin/python
+PIP := $(VENV)/bin/pip
+
+help:
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
+		awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-14s\033[0m %s\n", $$1, $$2}'
+
+install: ## Create venv and install the package with dev extras
+	uv venv --python 3.12 $(VENV) || python3 -m venv $(VENV)
+	. $(VENV)/bin/activate && (uv pip install -e ".[dev]" || pip install -e ".[dev]")
+
+migrate: ## Apply database migrations
+	. $(VENV)/bin/activate && alembic upgrade head
+
+revision: ## Autogenerate a new migration: make revision m="message"
+	. $(VENV)/bin/activate && alembic revision --autogenerate -m "$(m)"
+
+test: ## Run the full test suite
+	. $(VENV)/bin/activate && pytest
+
+test-fast: ## Run only tests that don't need the database
+	. $(VENV)/bin/activate && pytest -m "not db and not slow"
+
+lint: ## Ruff lint
+	. $(VENV)/bin/activate && ruff check src tests scripts
+
+fmt: ## Ruff autofix + format
+	. $(VENV)/bin/activate && ruff check --fix src tests scripts && ruff format src tests scripts
+
+typecheck: ## mypy
+	. $(VENV)/bin/activate && mypy src/coderag
+
+run: ## Run the API locally
+	. $(VENV)/bin/activate && uvicorn coderag.api.app:app --reload
+
+up: ## One-shot: build + start Postgres and the API (auto-migrate + demo index)
+	docker compose up -d --build
+	@echo "API:       http://localhost:8000"
+	@echo "Dashboard: http://localhost:8000/dashboard"
+
+down: ## Stop the stack (keeps the pgdata volume)
+	docker compose down
+
+logs: ## Follow the API logs
+	docker compose logs -f api
+
+demo: ## Index the bundled demo repo and run a sample search (no LLM needed)
+	. $(VENV)/bin/activate && coderag index ./examples/demo-repository \
+		&& coderag search "where are failed payments retried?"
+
+clean:
+	rm -rf $(VENV) .pytest_cache .ruff_cache .mypy_cache build dist *.egg-info

coderag_ai-0.3.0/NOTICE

@@ -0,0 +1,5 @@
+CodeRAG
+Copyright 2026 CodeRAG contributors
+
+This product includes software developed by the CodeRAG contributors.
+Licensed under the Apache License, Version 2.0 (see LICENSE).