deputy-cli 0.1.0__tar.gz

deputy_cli-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/configure-pages@v6
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.x
+      - run: pip install zensical
+      - run: zensical build --clean
+      - uses: actions/upload-pages-artifact@v5
+        with:
+          path: site
+      - uses: actions/deploy-pages@v5
+        id: deployment

deputy_cli-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: publish
+
+on:
+  push:
+    tags: ['v*']
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: git clone --depth 1 https://github.com/gurveervirk/deproc.git ../deproc
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - run: uv python install
+      - run: uv sync
+      - run: uv run pytest
+
+  publish:
+    needs: test
+    runs-on: ubuntu-latest
+    environment: pypi-deputy
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.x
+      - run: pip install build
+      - run: python -m build
+      - uses: pypa/gh-action-pypi-publish@release/v1

deputy_cli-0.1.0/.github/workflows/pytest.yml

@@ -0,0 +1,33 @@
+name: pytests
+
+on:
+  push:
+    branches: [ "main", "master" ]
+  pull_request:
+    branches: [ "main", "master" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout deputy
+      uses: actions/checkout@v5
+
+    - name: Clone deproc
+      run: git clone --depth 1 https://github.com/gurveervirk/deproc.git ../deproc
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
+
+    - name: Set up Python
+      run: uv python install
+
+    - name: Install dependencies
+      run: uv sync
+
+    - name: Run pytest
+      run: uv run pytest

deputy_cli-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

deputy_cli-0.1.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 2026 Gurveer Singh Virk
+
+   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.

deputy_cli-0.1.0/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: deputy-cli
+Version: 0.1.0
+Summary: A code intelligence CLI tool for querying and navigating code entities.
+Project-URL: Homepage, https://github.com/gurveervirk/deputy
+Project-URL: Repository, https://github.com/gurveervirk/deputy
+Project-URL: Documentation, https://gurveervirk.github.io/deputy/
+Author-email: Gurveer Singh Virk <gurveervirk.15517@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.12
+Requires-Dist: deproc-core>=0.1.0
+Requires-Dist: deproc-python>=0.1.0
+Requires-Dist: deproc-utils-tree-sitter>=0.1.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.26.8
+Description-Content-Type: text/markdown
+
+# deputy
+
+Code intelligence CLI for Python. Parses source files with [deproc](https://github.com/gurveervirk/deproc), stores entities (classes, functions, imports, etc.) in a local SQLite database, and provides commands to search, inspect, and resolve symbols.
+
+**[Full documentation →](https://gurveervirk.github.io/deputy/)**
+
+## Installation
+
+```bash
+pip install deputy-cli
+# or: uv tool install deputy-cli
+```
+
+## Quick start
+
+```bash
+deputy init                                    # create database
+deputy sync                                    # scan & index project
+deputy search "Model"                          # find entities matching regex
+deputy info deputy.core.create_context          # inspect an entity
+deputy resolve deputy.utils.storage.FileMetadata  # resolve through imports
+deputy subclasses myapp.models.BaseModel       # find direct subclasses
+deputy pin-inheritance myapp.models.Model Base models.py:10  # pin ambiguous base
+```
+
+## Configuration
+
+Deputy uses a key-value config file (`.deputyconfig`) in the project root:
+
+```bash
+deputy config enable_cache true       # cache resolution results
+deputy config auto_sync true          # auto-sync before queries
+deputy config display_mode tree       # tree view for search results
+deputy config sync_deps true          # index .venv dependencies
+```
+
+## Logging
+
+```bash
+deputy config log_level DEBUG         # most verbose
+deputy config log_level WARNING       # default
+deputy -v sync                        # one-off debug mode
+deputy --quiet search "Model"         # errors only
+```
+
+## Development
+
+```bash
+git clone https://github.com/gurveervirk/deputy
+cd deputy
+uv sync
+uv run pytest
+```
+
+## License
+
+See [LICENSE](LICENSE).

deputy_cli-0.1.0/README.md

@@ -0,0 +1,57 @@
+# deputy
+
+Code intelligence CLI for Python. Parses source files with [deproc](https://github.com/gurveervirk/deproc), stores entities (classes, functions, imports, etc.) in a local SQLite database, and provides commands to search, inspect, and resolve symbols.
+
+**[Full documentation →](https://gurveervirk.github.io/deputy/)**
+
+## Installation
+
+```bash
+pip install deputy-cli
+# or: uv tool install deputy-cli
+```
+
+## Quick start
+
+```bash
+deputy init                                    # create database
+deputy sync                                    # scan & index project
+deputy search "Model"                          # find entities matching regex
+deputy info deputy.core.create_context          # inspect an entity
+deputy resolve deputy.utils.storage.FileMetadata  # resolve through imports
+deputy subclasses myapp.models.BaseModel       # find direct subclasses
+deputy pin-inheritance myapp.models.Model Base models.py:10  # pin ambiguous base
+```
+
+## Configuration
+
+Deputy uses a key-value config file (`.deputyconfig`) in the project root:
+
+```bash
+deputy config enable_cache true       # cache resolution results
+deputy config auto_sync true          # auto-sync before queries
+deputy config display_mode tree       # tree view for search results
+deputy config sync_deps true          # index .venv dependencies
+```
+
+## Logging
+
+```bash
+deputy config log_level DEBUG         # most verbose
+deputy config log_level WARNING       # default
+deputy -v sync                        # one-off debug mode
+deputy --quiet search "Model"         # errors only
+```
+
+## Development
+
+```bash
+git clone https://github.com/gurveervirk/deputy
+cd deputy
+uv sync
+uv run pytest
+```
+
+## License
+
+See [LICENSE](LICENSE).

deputy_cli-0.1.0/docs/commands/config.md

@@ -0,0 +1,40 @@
+---
+title: config
+---
+
+# `deputy config`
+
+Read or write a configuration key in `.deputyconfig`.
+
+## Usage
+
+```bash
+deputy config <key> [value]
+```
+
+With a value, persists the key-value pair. Without a value, prints the current setting.
+
+## Available keys
+
+| Key | Default | Description |
+|-----|---------|-------------|
+| `db_path` | `.deputy.db` | Path to the SQLite database |
+| `venv_path` | *(auto-detected)* | Path to the project virtual environment |
+| `sync_deps` | `false` | Whether `deputy sync` should also index `.venv` dependencies |
+| `max_dep_files` | `5000` | Maximum files to index from dependencies |
+| `enable_cache` | `false` | Cache symbol resolution results (`deputy info --resolve`) |
+| `auto_sync` | `false` | Auto-sync before `search` and `info` if source files changed |
+| `log_level` | `WARNING` | Log level: `DEBUG`, `INFO`, `WARNING`, `ERROR` |
+| `log_file` | `.deputy/deputy.log` | Path to the log file |
+| `display_mode` | `table` | Search result display: `table` or `tree` |
+
+## Examples
+
+```bash
+deputy config enable_cache true
+deputy config display_mode tree
+deputy config log_level DEBUG
+deputy config auto_sync true
+```
+
+Log level also respects the `DEPUTY_LOG_LEVEL` environment variable.

deputy_cli-0.1.0/docs/commands/info.md

@@ -0,0 +1,81 @@
+---
+title: info
+---
+
+# `deputy info`
+
+Looks up an entity by its exact `full_path` and displays metadata and inheritance information.
+
+## Usage
+
+```bash
+deputy info <full_path> [options]
+```
+
+## Options
+
+| Flag | Description |
+|------|-------------|
+| `--all` / `-a` | Return every entity matching that `full_path` |
+| `--extract` / `-x` | Extract and display actual source text for signature/docstring |
+| `--columns` / `-c` | Comma-separated columns to display |
+| `--list-columns` | List all available columns and descriptions |
+| `--type` / `-t` | Filter by entity type (e.g. `FUNCTION`, `CLASS`) |
+| `--lineno` | Filter by line number |
+
+## Available columns
+
+Use `deputy info --list-columns` to see this list, or `-c` to select specific columns:
+
+| Column | Description |
+|--------|-------------|
+| `full_path` | Entity full path |
+| `language` | Language |
+| `type` | Entity type |
+| `lineno` | Starting line number |
+| `end_lineno` | Ending line number |
+| `source` | Source file:lineno |
+| `signature` | Signature location as path:line |
+| `arguments` | Arguments location as path:line |
+| `return_type` | Return type annotation location |
+| `docstring` | Docstring location as path:line |
+| `decorators` | Decorator names |
+| `parent_classes` | Parent/inherited class names |
+| `resolved_bases` | Resolved base class FQNs |
+| `unresolved_bases` | Unresolved base class names with candidate details |
+| `mro` | Full MRO chain |
+| `inherited_from` | Class in MRO providing this member (if inherited) |
+| `visibility` | `public` / `private` |
+| `exported` | Whether exported in `__all__` |
+
+## Class entities
+
+For class entities, `deputy info` automatically displays:
+
+- **Resolved and unresolved base classes**
+- **Full MRO chain** (method resolution order)
+- **Inherited members**
+
+When unresolved bases are found, it prints a hint:
+
+```
+Found unresolved bases: Base (conditional)
+Hint: use 'deputy resolve <module>.<name>' to trace imports,
+      then 'deputy pin-inheritance <class> <name> <file>:<line>' to pin
+```
+
+## Examples
+
+```bash
+# Show default columns
+deputy info myapp.models.Model
+
+# Show specific columns with extracted source text
+deputy info myapp.models.Model -c full_path,signature,docstring -x
+
+# Find all entities with this path
+deputy info myapp.models.Model --all
+
+# Filter by type and line number
+deputy info myapp.models.Model --type CLASS --lineno 42
+```

deputy_cli-0.1.0/docs/commands/init.md

@@ -0,0 +1,28 @@
+---
+title: init
+---
+
+# `deputy init`
+
+Creates a SQLite database and initialises the project.
+
+## Usage
+
+```bash
+deputy init [--path <db>]
+```
+
+## Options
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--path` / `-p` | `.deputy.db` | Database file path |
+
+## What it does
+
+1. Creates a SQLite database at the specified path
+2. Records the current directory as the project root
+3. Auto-detects the active virtual environment and writes `venv_path` to `.deputyconfig`
+
+!!! note
+    `.deputy.db` and `.deputyconfig` are gitignored - they are developer-local.

deputy_cli-0.1.0/docs/commands/overview.md

@@ -0,0 +1,42 @@
+---
+title: Commands Overview
+---
+
+# Commands Overview
+
+All commands accept these global flags:
+
+| Flag | Description |
+|------|-------------|
+| `--verbose` / `-v` | Set log level to `DEBUG` |
+| `--quiet` / `-q` | Set log level to `ERROR` |
+
+## Available commands
+
+| Command | Description |
+|---------|-------------|
+| [`init`](init.md) | Create a new database |
+| [`sync`](sync.md) | Scan and index project files |
+| [`search`](search.md) | Search entities by regex |
+| [`info`](info.md) | Inspect entity details |
+| [`resolve`](resolve.md) | Trace import chains to original definition |
+| [`subclasses`](subclasses.md) | Find direct or transitive subclasses |
+| [`pin-inheritance`](pin-inheritance.md) | Disambiguate unresolved base classes |
+| [`config`](config.md) | Read or write configuration |
+
+## Typical workflow
+
+```bash
+# Setup
+deputy init
+deputy sync
+
+# Query
+deputy search "MyClass"
+deputy info mypackage.module.MyClass
+deputy resolve mypackage.aliases.MyClass
+
+# Inheritance
+deputy subclasses mypackage.module.MyClass
+deputy pin-inheritance mypackage.module.MyClass Base src/module.py:12
+```