rylox 0.0.1__tar.gz

rylox-0.0.1/.github/CODEOWNERS

@@ -0,0 +1,25 @@
+# ------------------------------------------------------------
+# Rylox Code Owners
+#
+# Code owners are automatically requested to review pull requests
+# that modify matching files.
+# ------------------------------------------------------------
+
+# GitHub configuration
+.github/ @CODING-DARSH
+
+# Source code
+src/ @CODING-DARSH
+
+# Tests
+tests/ @CODING-DARSH
+
+# Documentation
+docs/ @CODING-DARSH
+
+README.md @CODING-DARSH
+CONTRIBUTING.md @CODING-DARSH
+CONTRIBUTORS.md @CODING-DARSH
+
+# Default owner
+* @CODING-DARSH

rylox-0.0.1/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,64 @@
+name: Bug Report
+description: Report a bug or unexpected behavior in Rylox.
+title: "[Bug]: "
+labels:
+  - bug
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to report a bug.
+
+        Please provide as much information as possible so we can reproduce and investigate the issue.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of the problem.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce
+      placeholder: |
+        1.
+        2.
+        3.
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual behavior
+    validations:
+      required: true
+
+  - type: input
+    id: python
+    attributes:
+      label: Python version
+      placeholder: "3.11"
+
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      placeholder: Windows / Linux / macOS
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Additional context
+      description: Paste stack traces, logs, screenshots, or any other useful information.

rylox-0.0.1/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+blank_issues_enabled: true
+
+contact_links:
+
+  - name: 📖 Contributing Guide
+    url: https://github.com/CODING-DARSH/rylox/blob/main/CONTRIBUTING.md
+    about: Read the contribution guidelines before opening a pull request.

rylox-0.0.1/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,36 @@
+name: Feature Request
+description: Suggest a new feature or improvement.
+title: "[Feature]: "
+labels:
+  - enhancement
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for helping improve Rylox.
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem
+      description: What problem does this feature solve?
+    validations:
+      required: true
+
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context

rylox-0.0.1/.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,25 @@
+name: Question / Discussion
+description: Ask a question or start a discussion about Rylox.
+title: "[Question]: "
+labels:
+  - question
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for your interest in Rylox!
+
+        Feel free to ask questions about usage, design decisions, implementation details, or anything else related to the project.
+
+  - type: textarea
+    id: question
+    attributes:
+      label: Your question
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context

rylox-0.0.1/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,38 @@
+## Summary
+
+Describe your changes.
+
+---
+
+## Type of Change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation
+- [ ] Tests
+- [ ] Refactoring
+- [ ] Performance improvement
+- [ ] Other
+
+---
+
+## Testing
+
+Describe how you tested your changes.
+
+---
+
+## Checklist
+
+- [ ] My code follows the project's coding style.
+- [ ] I have added or updated tests where appropriate.
+- [ ] I have updated documentation if needed.
+- [ ] `ruff check . --fix` passes.
+- [ ] `mypy src` passes.
+- [ ] `pytest -v --cov=rylox --cov-report=term-missing` passes.
+
+---
+
+## Additional Notes
+
+Add any additional context, screenshots, or implementation details here.

rylox-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    name: py${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install package (editable, with dev deps)
+        run: pip install -e ".[dev]"
+
+      - name: Lint (ruff)
+        run: ruff check .
+
+      - name: Type check (mypy)
+        run: mypy src
+
+      - name: Unit + regression + integration tests (pytest)
+        run: pytest -v --cov=rylox --cov-report=term-missing

rylox-0.0.1/.gitignore

@@ -0,0 +1,21 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Rylox's own local index cache (also gitignored per-repo at runtime, see §2)
+.rylox/
+
+.vscode/
+.idea/
+.DS_Store
+KNOWN_LIMITATIONS.md

rylox-0.0.1/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is inspired by Keep a Changelog and this project follows Semantic Versioning.
+
+---
+
+## [0.0.1] - 2026-07-06
+
+### Added
+
+- Initial project structure and Python packaging.
+- Command-line interface built with Typer.
+- Configuration system with `rylox.toml`.
+- Tree-sitter based Python parsing.
+- Function, method, and class level semantic chunking.
+- Persistent on-disk index cache.
+- Incremental repository indexing using SHA-256 content hashing.
+- Configurable ignore patterns and `.gitignore` support.
+- Cross-platform test suite.
+- Continuous Integration with Ruff, mypy, and pytest.
+- Repository documentation and contribution guidelines.
+- GitHub issue forms, pull request template, and CODEOWNERS.
+
+### Notes
+
+This is the first public release of Rylox.
+
+The project is currently under active development. While the indexing
+foundation is complete, context generation and retrieval capabilities are
+still being implemented as part of the planned v0.1.0 milestone.

rylox-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,138 @@
+# Contributing to Rylox
+
+First off, thank you for considering contributing to Rylox!
+
+Rylox is an offline, vendor-independent repository context engine focused on correctness, deterministic behavior, and maintainable code. Whether you're fixing a bug, improving documentation, or implementing a new feature, your contribution is appreciated.
+
+---
+
+## Development Setup
+
+Clone the repository and install the project in editable mode with development dependencies.
+
+```bash
+git clone https://github.com/<your-username>/rylox.git
+cd rylox
+
+pip install -e ".[dev]"
+```
+
+---
+
+## Running Quality Checks
+
+Before opening a pull request, ensure all quality checks pass.
+
+```bash
+ruff check . --fix
+mypy src
+pytest -v --cov=rylox --cov-report=term-missing
+```
+
+Pull requests that fail linting, type checking, or tests should be fixed before review.
+
+---
+
+## Code Style
+
+Please follow the existing project style.
+
+- Add type hints to public functions.
+- Keep functions focused and easy to understand.
+- Prefer readable code over clever code.
+- Add or update tests for every bug fix or feature.
+- Avoid introducing unnecessary dependencies.
+- Keep changes scoped to a single logical purpose.
+
+Formatting and linting are enforced using **Ruff**, while static type checking is performed using **mypy**.
+
+---
+
+## Pull Requests
+
+Before opening a pull request:
+
+- Ensure all quality checks pass.
+- Add tests for new functionality or bug fixes.
+- Update documentation if user-facing behavior changes.
+- Keep commits focused and use clear commit messages.
+- Follow Conventional Commits where possible:
+
+  - `feat:` — New feature
+  - `fix:` — Bug fix
+  - `docs:` — Documentation changes
+  - `test:` — Tests
+  - `refactor:` — Code refactoring
+  - `chore:` — Maintenance tasks
+
+A good pull request should clearly explain:
+
+- What changed.
+- Why the change was necessary.
+- Any important implementation details.
+- Reference related issues when applicable.
+
+---
+
+## Reporting Bugs
+
+When reporting a bug, please include:
+
+- Operating system
+- Python version
+- Steps to reproduce
+- Expected behavior
+- Actual behavior
+- Full error message or traceback (if available)
+
+Providing a minimal reproducible example makes issues much easier to investigate.
+
+---
+
+## Feature Requests
+
+Feature requests are always welcome.
+
+When proposing a new feature, please explain:
+
+- The problem you're trying to solve.
+- Why the feature would benefit Rylox users.
+- Any potential design or implementation ideas.
+
+Opening an issue for discussion before starting implementation is encouraged for larger features.
+
+---
+
+## Project Philosophy
+
+Rylox is built around a few core principles:
+
+- **Offline First** — Indexing and retrieval should never require network access.
+- **Vendor Independent** — Generated context should work with any language model.
+- **Deterministic** — Identical inputs should produce identical outputs.
+- **Well Tested** — New functionality should include appropriate automated test coverage.
+
+Contributions should align with these principles whenever possible.
+
+---
+---
+
+## Recognition
+
+We believe contributors should receive proper credit for their work.
+
+After a pull request is merged:
+
+- Your name or GitHub username will be added to **`CONTRIBUTORS.md`**.
+- Your contribution will be credited in the release notes for the version in which it is included.
+- Major contributions will be acknowledged alongside the corresponding feature or improvement whenever possible.
+
+Every contribution—whether it's code, tests, documentation, or bug fixes—is valued and appreciated.
+
+---
+
+## Questions
+
+If you're unsure about an implementation or would like feedback before starting work, feel free to open an issue for discussion.
+
+Every contribution, no matter how small, is appreciated. Thank you for helping make Rylox better!

rylox-0.0.1/CONTRIBUTORS.md

@@ -0,0 +1,21 @@
+# Contributors
+
+Rylox is built by its community. Thank you to everyone who contributes code, tests, documentation, bug reports, and ideas. ❤️
+
+This list is maintained manually alongside GitHub's contributors graph. If you've had a pull request merged and don't see yourself listed here, feel free to open a pull request adding your name.
+
+---
+
+## Maintainer
+
+**Darsh (@CODING-DARSH)** — Creator & Lead Maintainer
+
+---
+
+## Contributors
+
+Listed by first contribution. Pull request numbers link the corresponding work.
+
+*No community contributions yet.*
+
+Interested in contributing? See **CONTRIBUTING.md** to get started. Every merged pull request earns a place in this file and is credited in the corresponding release notes.

rylox-0.0.1/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 2026 Rylox contributors
+
+   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.