depsight 0.4.0__tar.gz

depsight-0.4.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 [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.

depsight-0.4.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: depsight
+Version: 0.4.0
+Summary: A modular dependency analysis framework
+Author: Depsight Contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/depsight/depsight-dependency-manager
+Project-URL: Repository, https://github.com/depsight/depsight-dependency-manager
+Project-URL: Issues, https://github.com/depsight/depsight-dependency-manager/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1.7
+Requires-Dist: rich>=13.7.0
+Requires-Dist: rich-click>=1.7.0
+Dynamic: license-file
+
+# Depsight - Dependency Analysis Framework
+
+## Usage
+
+### Installation
+
+#### Via pip
+
+```bash
+pip install depsight
+```
+
+#### Via uv
+
+```bash
+uv tool install depsight
+```
+
+#### Via Docker
+
+```bash
+docker pull <your-dockerhub-user>/depsight
+```
+
+### Getting Started
+
+Read the docs.
+
+## Development
+
+### System Requirements
+
+- **IDE with DevContainer support** — either of the following:
+    - [Visual Studio Code](https://code.visualstudio.com/) with the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension
+    - [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/) (supports Dev Containers via the Remote Development plugin)
+- **Container manager** — any one of the following:
+    - [Docker Desktop](https://www.docker.com/products/docker-desktop/) (macOS, Windows, Linux) (**RECOMMENDED**)
+    - [Docker Engine](https://docs.docker.com/engine/install/) (Linux)
+    - [Podman](https://podman.io/) with the Podman Desktop or CLI
+
+### Setup Locally
+
+- Open Visual Studio Code at the project root directory
+- When prompted, click **Reopen in Container** (or use Command Palette: `Dev Containers: Reopen in Container`)
+
+  <img src="./images/reopen_in_container.png" alt="Logo" width="400"/>
+
+- Wait for the containers to build and start
+- Once ready, you'll have a fully configured development environment with all dependencies installed
+- Open a terminal inside the DevContainer and run `depsight --help`
+
+### Build Container Image
+
+- Open a terminal inside the DevContainer (Docker-in-Docker is available)
+- Build the image:
+
+  ```bash
+  docker build -t depsight .
+  ```
+
+- Optionally override the Python or uv version via build args:
+
+  ```bash
+  docker build -t depsight --build-arg PYTHON_VERSION=3.13 --build-arg UV_VERSION=0.10.9 .
+  ```
+
+- Verify the image works:
+
+  ```bash
+  docker run --rm depsight --help
+  ```
+
+### Run Tests
+
+- Open a terminal inside the DevContainer
+- Activate the virtual environment:
+
+  ```bash
+  source .venv/bin/activate
+  ```
+
+- Run all tests:
+
+  ```bash
+  pytest tests/ -v
+  ```
+
+### Lint & Type Check
+
+- Run the Ruff linter:
+
+  ```bash
+  ruff check src/ tests/
+  ```
+
+- Run the Mypy type checker:
+
+  ```bash
+  mypy src/
+  ```
+
+### Build Docs
+
+- Open a terminal inside the DevContainer
+- Activate the virtual environment:
+
+  ```bash
+  source .venv/bin/activate
+  ```
+
+- Serve the documentation locally with live reload:
+
+  ```bash
+  mkdocs serve
+  ```
+
+  The site will be available at `http://127.0.0.1:8000`.
+
+- Alternatively, build the static site as a `site/` directory:
+
+  ```bash
+  mkdocs build
+  ```
+
+## Build
+
+### Pre-release
+
+Use this to trigger a build manually at any time without creating a release.
+
+- Navigate to your repository on GitHub and click the **Actions** tab
+- Select the **Manual Dispatch** workflow from the left sidebar
+- Click **Run workflow**
+- Enter the `depsight_version` (must match the `version` field in `pyproject.toml`, e.g. `0.1.0`)
+- Select the desired `python_version` (`3.12` or `3.13`, defaults to `3.12`)
+- Optionally set `uv_version` (defaults to `0.10.9`)
+- Optionally check **Upload wheel as artifact** to download the built `.whl` after the run
+- Click **Run workflow**
+- Once the run completes, the wheel is available under the run's **Artifacts** section (if enabled)
+
+### Release
+
+Use this to publish an official versioned build. The wheel is automatically attached to the GitHub Release.
+
+- Bump the `version` field in `pyproject.toml` to the desired version (e.g. `1.2.3`)
+- Commit and push the change to `main`
+- Navigate to your repository on GitHub and click **Releases** → **Draft a new release**
+- Create a new tag matching the version in `pyproject.toml` exactly (e.g. `1.2.3`)
+- Click **Publish release**
+- The **On Release** workflow triggers automatically, runs the full CI pipeline, and uploads the `.whl` to the release assets

depsight-0.4.0/README.md

@@ -0,0 +1,150 @@
+# Depsight - Dependency Analysis Framework
+
+## Usage
+
+### Installation
+
+#### Via pip
+
+```bash
+pip install depsight
+```
+
+#### Via uv
+
+```bash
+uv tool install depsight
+```
+
+#### Via Docker
+
+```bash
+docker pull <your-dockerhub-user>/depsight
+```
+
+### Getting Started
+
+Read the docs.
+
+## Development
+
+### System Requirements
+
+- **IDE with DevContainer support** — either of the following:
+    - [Visual Studio Code](https://code.visualstudio.com/) with the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension
+    - [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/) (supports Dev Containers via the Remote Development plugin)
+- **Container manager** — any one of the following:
+    - [Docker Desktop](https://www.docker.com/products/docker-desktop/) (macOS, Windows, Linux) (**RECOMMENDED**)
+    - [Docker Engine](https://docs.docker.com/engine/install/) (Linux)
+    - [Podman](https://podman.io/) with the Podman Desktop or CLI
+
+### Setup Locally
+
+- Open Visual Studio Code at the project root directory
+- When prompted, click **Reopen in Container** (or use Command Palette: `Dev Containers: Reopen in Container`)
+
+  <img src="./images/reopen_in_container.png" alt="Logo" width="400"/>
+
+- Wait for the containers to build and start
+- Once ready, you'll have a fully configured development environment with all dependencies installed
+- Open a terminal inside the DevContainer and run `depsight --help`
+
+### Build Container Image
+
+- Open a terminal inside the DevContainer (Docker-in-Docker is available)
+- Build the image:
+
+  ```bash
+  docker build -t depsight .
+  ```
+
+- Optionally override the Python or uv version via build args:
+
+  ```bash
+  docker build -t depsight --build-arg PYTHON_VERSION=3.13 --build-arg UV_VERSION=0.10.9 .
+  ```
+
+- Verify the image works:
+
+  ```bash
+  docker run --rm depsight --help
+  ```
+
+### Run Tests
+
+- Open a terminal inside the DevContainer
+- Activate the virtual environment:
+
+  ```bash
+  source .venv/bin/activate
+  ```
+
+- Run all tests:
+
+  ```bash
+  pytest tests/ -v
+  ```
+
+### Lint & Type Check
+
+- Run the Ruff linter:
+
+  ```bash
+  ruff check src/ tests/
+  ```
+
+- Run the Mypy type checker:
+
+  ```bash
+  mypy src/
+  ```
+
+### Build Docs
+
+- Open a terminal inside the DevContainer
+- Activate the virtual environment:
+
+  ```bash
+  source .venv/bin/activate
+  ```
+
+- Serve the documentation locally with live reload:
+
+  ```bash
+  mkdocs serve
+  ```
+
+  The site will be available at `http://127.0.0.1:8000`.
+
+- Alternatively, build the static site as a `site/` directory:
+
+  ```bash
+  mkdocs build
+  ```
+
+## Build
+
+### Pre-release
+
+Use this to trigger a build manually at any time without creating a release.
+
+- Navigate to your repository on GitHub and click the **Actions** tab
+- Select the **Manual Dispatch** workflow from the left sidebar
+- Click **Run workflow**
+- Enter the `depsight_version` (must match the `version` field in `pyproject.toml`, e.g. `0.1.0`)
+- Select the desired `python_version` (`3.12` or `3.13`, defaults to `3.12`)
+- Optionally set `uv_version` (defaults to `0.10.9`)
+- Optionally check **Upload wheel as artifact** to download the built `.whl` after the run
+- Click **Run workflow**
+- Once the run completes, the wheel is available under the run's **Artifacts** section (if enabled)
+
+### Release
+
+Use this to publish an official versioned build. The wheel is automatically attached to the GitHub Release.
+
+- Bump the `version` field in `pyproject.toml` to the desired version (e.g. `1.2.3`)
+- Commit and push the change to `main`
+- Navigate to your repository on GitHub and click **Releases** → **Draft a new release**
+- Create a new tag matching the version in `pyproject.toml` exactly (e.g. `1.2.3`)
+- Click **Publish release**
+- The **On Release** workflow triggers automatically, runs the full CI pipeline, and uploads the `.whl` to the release assets

depsight-0.4.0/pyproject.toml

@@ -0,0 +1,56 @@
+[project]
+name = "depsight"
+version = "0.4.0"
+description = "A modular dependency analysis framework"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.12"
+authors = [
+    { name = "Depsight Contributors" },
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Build Tools",
+]
+dependencies = [
+    "click>=8.1.7",
+    "rich>=13.7.0",
+    "rich-click>=1.7.0",
+]
+
+[dependency-groups]
+dev = [
+    "mypy>=1.10",
+    "pytest>=8.0",
+    "ruff>=0.4",
+]
+docs = [
+    "mkdocs>=1.6",
+    "mkdocs-material>=9.5",
+    "mkdocs-mermaid2-plugin>=1.1",
+]
+
+[project.scripts]
+depsight = "depsight.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/depsight/depsight-dependency-manager"
+Repository = "https://github.com/depsight/depsight-dependency-manager"
+Issues = "https://github.com/depsight/depsight-dependency-manager/issues"
+
+# Plugin support
+[project.entry-points."depsight.plugins"]
+uv = "depsight.core.plugins.uv.uv:UVPlugin"
+vsce = "depsight.core.plugins.vsce.vsce:VSCEPlugin"
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

depsight-0.4.0/setup.cfg

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

depsight-0.4.0/src/depsight/__init__.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__ = version("depsight")

depsight-0.4.0/src/depsight/cli.py

@@ -0,0 +1,99 @@
+import sys
+
+# third-party imports
+import rich_click as click
+
+from depsight import __version__
+from depsight.core.dispatcher import dispatch_command
+from depsight.utils.constants import APP_BANNER, COLOR_DIM_ORANGE, COLOR_PEACH, SUPPORTED_PLUGINS
+
+# rich-click styling
+click.rich_click.USE_RICH_MARKUP = True
+click.rich_click.GROUP_ARGUMENTS_OPTIONS = True
+click.rich_click.STYLE_COMMANDS_TABLE_COLUMN_WIDTH_RATIO = (1, 2)
+click.rich_click.HEADER_TEXT = APP_BANNER
+click.rich_click.STYLE_COMMAND = COLOR_DIM_ORANGE
+click.rich_click.STYLE_OPTION = COLOR_DIM_ORANGE
+click.rich_click.STYLE_SWITCH = COLOR_PEACH
+click.rich_click.STYLE_USAGE = f"bold {COLOR_PEACH}"
+click.rich_click.STYLE_USAGE_COMMAND = f"bold {COLOR_DIM_ORANGE}"
+click.rich_click.STYLE_USAGE_SEPARATOR = COLOR_DIM_ORANGE
+click.rich_click.STYLE_METAVAR = COLOR_PEACH
+click.rich_click.STYLE_METAVAR_APPEND = COLOR_PEACH
+click.rich_click.STYLE_ARGUMENT = COLOR_PEACH
+click.rich_click.COMMAND_GROUPS = {
+    "depsight": [{"name": "Package Managers", "commands": list(SUPPORTED_PLUGINS.keys())}]
+}
+
+
+@click.group()
+@click.version_option(__version__, "--version", "-V", prog_name="depsight")
+def main():
+    """A modern TUI framework for scanning local project dependencies."""
+    pass
+
+
+def _register_plugin(plugin_name: str):
+    """Register a plugin as a Click subgroup with its commands.
+
+    Creates a new :func:`click.Group` attached to :func:`main` and registers
+    all available sub-commands (e.g. `scan`) under it.  This function is
+    called at **module import time** for every key in
+    :data:`~depsight.core.registry.SUPPORTED_PLUGINS` so that the commands are
+    available before Click parses the CLI arguments.
+
+    Parameters
+    ----------
+    plugin_name : str
+        Key in `SUPPORTED_PLUGINS` identifying the plugin (e.g. `"uv"`).
+    """
+
+    @main.group(plugin_name, help=f"Commands for the '{plugin_name}' package manager.")
+    @click.pass_context
+    def plugin_group(ctx):
+        """Entry point for a plugin subgroup that stores the plugin name in the context."""
+        ctx.ensure_object(dict)
+        ctx.obj["plugin_name"] = plugin_name
+
+
+    #
+    # SCAN COMMAND
+    # # # # # # # #
+    @plugin_group.command("scan")
+    @click.option(
+        "--project-dir",
+        type=click.Path(exists=True),
+        required=True,
+        help="Path to the project."
+    )
+    @click.option(
+        "--verbose",
+        is_flag=True,
+        help="Enable verbose logging."
+    )
+    @click.option(
+        "--as-csv",
+        is_flag=True,
+        help="Export scan results to a CSV file."
+    )
+    @click.pass_context
+    def scan(ctx, project_dir, verbose, as_csv):
+        """Scan project dependencies using the selected plugin."""
+        options = {
+            "plugin_name": ctx.obj["plugin_name"],
+            "project_dir": project_dir,
+            "verbose": verbose,
+            "as_csv": as_csv,
+        }
+        sys.exit(dispatch_command("scan", options))
+
+
+#
+# PLUGIN REGISTRATION
+# # # # # # # # #
+for _name in SUPPORTED_PLUGINS:
+    _register_plugin(_name)
+
+
+if __name__ == "__main__":
+    main()