cargoscope 0.9.1__py3-none-win_amd64.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
Binary file
|
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: cargoscope
|
|
3
|
+
Version: 0.9.1
|
|
4
|
+
Classifier: Programming Language :: Rust
|
|
5
|
+
Classifier: Environment :: Console
|
|
6
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
7
|
+
Summary: Understand every dependency in your Rust project: advisories, unused dependencies, licenses, versions and why each one is there
|
|
8
|
+
Home-Page: https://github.com/HarpeLm/CargoScope#readme
|
|
9
|
+
License-Expression: MIT
|
|
10
|
+
Requires-Python: >=3.8
|
|
11
|
+
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
|
|
12
|
+
Project-URL: Repository, https://github.com/HarpeLm/CargoScope
|
|
13
|
+
|
|
14
|
+
<div align="center">
|
|
15
|
+
|
|
16
|
+
<picture>
|
|
17
|
+
<source media="(prefers-color-scheme: light)" srcset="docs/images/banner-light.svg">
|
|
18
|
+
<source media="(prefers-color-scheme: dark)" srcset="docs/images/banner.svg">
|
|
19
|
+
<img alt="CargoScope — One offline report for your Rust/Cargo dependencies" src="docs/images/banner.svg">
|
|
20
|
+
</picture>
|
|
21
|
+
|
|
22
|
+
<br/>
|
|
23
|
+
|
|
24
|
+
[](https://crates.io/crates/cargoscope)
|
|
25
|
+
[](https://github.com/HarpeLm/CargoScope/actions/workflows/ci.yml)
|
|
26
|
+
[](https://github.com/HarpeLm/CargoScope/pkgs/container/cargoscope)
|
|
27
|
+
[](docs/compatibility.md)
|
|
28
|
+
[](LICENSE)
|
|
29
|
+
|
|
30
|
+
[Quick Start](#quick-start) · [Install](#install) · [GitHub Action](#github-action) · [How It Works](#how-it-works) · [Benchmarks](#benchmarks) · [Docs](#documentation) · [Security](SECURITY.md) · [Changelog](CHANGELOG.md)
|
|
31
|
+
|
|
32
|
+
</div>
|
|
33
|
+
|
|
34
|
+

|
|
35
|
+
|
|
36
|
+
CargoScope is a 100% Rust CLI for Rust/Cargo projects that replaces five separate dependency tools with **one fast offline report**: resolved inventory, RustSec advisories ranked by relevance (`affects-you` / `possibly` / `unlikely`), static and compiler-verified unused dependencies, `deny.toml` license/ban/source policies, SemVer updates, maintenance health, and automated fixes or PRs.
|
|
37
|
+
|
|
38
|
+
## Benchmarks
|
|
39
|
+
|
|
40
|
+
| Median offline scan | Advisory parity | Policy parity | Unused-dependency precision |
|
|
41
|
+
|---|---|---|---|
|
|
42
|
+
| **`22 ms`** | **`1,376 / 1,376`** | **`44 / 44`** | **`100%` (`--precise`) / `98.9%` (static)** |
|
|
43
|
+
| Across 72 compiled repos (0 code exec) | Identical to `cargo-audit` (74 unseen repos) | Identical to `cargo-deny` (`deny.toml`) | 35 blind `--precise` repos / 80-repo `rustc` judge |
|
|
44
|
+
|
|
45
|
+
Full methodology, exact commits, and raw outputs: [tests/corpus/README.md](tests/corpus/README.md) & [precise-benchmark.md](tests/corpus/precise-benchmark.md).
|
|
46
|
+
|
|
47
|
+
## Quick Start
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
# 1. Instant zero-network scan (inventory + unused dependencies)
|
|
51
|
+
cargoscope scan . --checks inventory,unused
|
|
52
|
+
|
|
53
|
+
# 2. Full scan: download RustSec + crates.io metadata once, then inspect offline
|
|
54
|
+
cargoscope scan . --update --fast
|
|
55
|
+
|
|
56
|
+
# 3. Preview fixes without modifying any file (pass --apply to write)
|
|
57
|
+
cargoscope fix . # remove likely-unused deps & clean [features]
|
|
58
|
+
cargoscope fix --advisories . # bump Cargo.lock & matching workspace manifests
|
|
59
|
+
cargoscope fix --updates . # Dependabot-style compatible/breaking upgrades
|
|
60
|
+
|
|
61
|
+
# 4. Bootstrap cargoscope.toml (or migrate deny.toml) and GitHub CI workflow
|
|
62
|
+
cargoscope init --ci
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
New here? Follow the [two-minute walkthrough](docs/try-it.md) or read the full [command reference](docs/commands.md).
|
|
66
|
+
|
|
67
|
+
## Install
|
|
68
|
+
|
|
69
|
+
```sh
|
|
70
|
+
# macOS / Linux prebuilt binary
|
|
71
|
+
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/HarpeLm/CargoScope/releases/latest/download/cargoscope-installer.sh | sh
|
|
72
|
+
|
|
73
|
+
# Homebrew (macOS / Linux)
|
|
74
|
+
brew install HarpeLm/tap/cargoscope
|
|
75
|
+
|
|
76
|
+
# crates.io
|
|
77
|
+
cargo install cargoscope
|
|
78
|
+
|
|
79
|
+
# npm (downloads the native binary, no JS engine logic)
|
|
80
|
+
npx cargoscope scan . --update
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
> **PyPI (`pip install cargoscope` / `uvx cargoscope scan .`)**: the Trusted Publisher workflow ([pypi.yml](.github/workflows/pypi.yml)) is configured and ships Python wheels starting with `v0.9.0`.
|
|
84
|
+
|
|
85
|
+
<details>
|
|
86
|
+
<summary>Windows PowerShell, Docker (ghcr.io/harpelm/cargoscope), and GitLab CI</summary>
|
|
87
|
+
|
|
88
|
+
```powershell
|
|
89
|
+
# Windows prebuilt binary (PowerShell)
|
|
90
|
+
irm https://github.com/HarpeLm/CargoScope/releases/latest/download/cargoscope-installer.ps1 | iex
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
```sh
|
|
94
|
+
# Docker container (linux/amd64 and linux/arm64; use `:full` when running `fix` or `--precise`)
|
|
95
|
+
docker run --rm -v "$PWD:/src" -v cargoscope-cache:/cache ghcr.io/harpelm/cargoscope update .
|
|
96
|
+
docker run --rm -v "$PWD:/src" -v cargoscope-cache:/cache ghcr.io/harpelm/cargoscope scan .
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
```yaml
|
|
100
|
+
# GitLab CI
|
|
101
|
+
cargoscope:
|
|
102
|
+
image:
|
|
103
|
+
name: ghcr.io/harpelm/cargoscope:0.9.1
|
|
104
|
+
entrypoint: [""]
|
|
105
|
+
script:
|
|
106
|
+
- cargoscope update .
|
|
107
|
+
- cargoscope scan . --format sarif --output cargoscope.sarif --fail-on high
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
</details>
|
|
111
|
+
|
|
112
|
+
## What One Scan Replaces
|
|
113
|
+
|
|
114
|
+
| Capability | Replaces | What CargoScope adds |
|
|
115
|
+
|---|---|---|
|
|
116
|
+
| **Advisories & binary audit** | `cargo-audit` | Matches `cargo-audit` on 1,376 advisories, ranks relevance (`affects-you` / `possibly` / `unlikely`), adds `--ignore-unlikely`, CycloneDX VEX, and `audit-bin` |
|
|
117
|
+
| **Unused dependencies** | `cargo-machete`, `cargo-shear` | Lexer-based static analysis with per-finding evidence, opt-in `rustc` `--precise` mode, `[features]` & `[workspace.dependencies]` cleanup via `fix` |
|
|
118
|
+
| **Licenses, bans & sources** | `cargo-deny` | Reads `deny.toml` natively (`cargoscope init` also migrates it), checks SPDX/license files, feature & build-script bans, and `[graph]` targets (44/44 parity) |
|
|
119
|
+
| **Versions, yanked & weights** | `cargo-outdated`, `cargo-tree` | Splits `compatible` vs `breaking` updates, flags archived/stale/single-owner crates, duplicate versions, and pruning weights (`cargoscope why`) |
|
|
120
|
+
| **PR automation & CI** | Dependabot | Opens security & SemVer PRs with MSRV/license diffs, changelogs, `/cargoscope rebase \| recreate \| ignore`, offline HTML, SARIF, and `aggregate` |
|
|
121
|
+
|
|
122
|
+
## How It Works
|
|
123
|
+
|
|
124
|
+

|
|
125
|
+
|
|
126
|
+
- **Local & offline by default**: `scan`, `why`, `compare`, `aggregate`, and `audit-bin` make zero network requests unless you run `cargoscope update` (or `scan --update`).
|
|
127
|
+
- **No code execution**: manifests, lockfiles, policies, and `.rs` tokens are read directly — build scripts and proc macros never run unless you opt into `--precise`.
|
|
128
|
+
- **No silent writes**: nothing on disk changes except when you explicitly pass `cargoscope fix --apply` or `cargoscope init`.
|
|
129
|
+
- **Evidence first**: every finding shows its dependency chain, provenance, and cache date.
|
|
130
|
+
- **Memory safe (`unsafe_code = "forbid"`)**: enforced workspace-wide with hardened symlink, depth, and file-size bounds ([SECURITY.md](SECURITY.md)).
|
|
131
|
+
|
|
132
|
+
## Visual Outputs & Automated PRs
|
|
133
|
+
|
|
134
|
+
<table>
|
|
135
|
+
<tr>
|
|
136
|
+
<td width="50%" valign="top">
|
|
137
|
+
<a href="docs/commands.md#cargoscope-scan"><img src="docs/images/html-report.svg" alt="CargoScope offline HTML report" width="100%"/></a>
|
|
138
|
+
<br/>
|
|
139
|
+
<strong>Self-contained HTML, SARIF & CycloneDX</strong><br/>
|
|
140
|
+
Export one offline report (<code>--format html</code>), GitHub Code Scanning results (<code>--format sarif</code>), CycloneDX 1.5 VEX SBOMs (<code>--format cyclonedx</code>), or merge multiple repos via <code>cargoscope aggregate</code>.
|
|
141
|
+
</td>
|
|
142
|
+
<td width="50%" valign="top">
|
|
143
|
+
<a href="docs/github-action.md"><img src="docs/images/pr-preview.svg" alt="CargoScope-Bot pull request preview" width="100%"/></a>
|
|
144
|
+
<br/>
|
|
145
|
+
<strong>Automated PRs via CargoScope-Bot</strong><br/>
|
|
146
|
+
Schedule security (<code>fix --advisories</code>) and SemVer update PRs with MSRV/license checks, <code>diff.rs</code> links, changelogs, Cargo refusal reasons, and <code>/cargoscope rebase | ignore</code> commands.
|
|
147
|
+
</td>
|
|
148
|
+
</tr>
|
|
149
|
+
</table>
|
|
150
|
+
|
|
151
|
+
## GitHub Action
|
|
152
|
+
|
|
153
|
+
Drop [**CargoScope-Bot**](https://github.com/marketplace/actions/cargoscope-bot) into any CI workflow (downloads the prebuilt binary, caches RustSec/crates.io data, and comments PR diffs when permissions allow):
|
|
154
|
+
|
|
155
|
+
```yaml
|
|
156
|
+
- uses: HarpeLm/CargoScope@v0.9.1
|
|
157
|
+
with:
|
|
158
|
+
fail-on: high
|
|
159
|
+
upload-sarif: false
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
For full SARIF uploads, scheduled security PRs, and Dependabot-style update PRs, see [docs/github-action.md](docs/github-action.md).
|
|
163
|
+
|
|
164
|
+
## Documentation
|
|
165
|
+
|
|
166
|
+
| Guide | Covers |
|
|
167
|
+
|---|---|
|
|
168
|
+
| [docs/try-it.md](docs/try-it.md) | 2-minute walkthrough on a sample project |
|
|
169
|
+
| [docs/commands.md](docs/commands.md) | Full CLI reference (`scan`, `update` & proxies, `--precise`, `fix`, `why`, `audit-bin`, `compare`, `aggregate`, `init`) |
|
|
170
|
+
| [docs/github-action.md](docs/github-action.md) | **CargoScope-Bot** CI workflows, security PRs, Dependabot-style `[updates]`, and `/cargoscope` commands |
|
|
171
|
+
| [docs/policy.md](docs/policy.md) | Policy rules (`cargoscope.toml`, `deny.toml` & `.cargo/audit.toml`), licenses, `[bans.build]`, and `[graph]` scoping |
|
|
172
|
+
| [docs/json-report.md](docs/json-report.md) | Versioned JSON output (`format_version: 1`) and [JSON schema](docs/schema/report-v1.json) |
|
|
173
|
+
| [docs/compatibility.md](docs/compatibility.md) | `1.x` stability contract (CLI, exit codes `0`/`1`/`2`, JSON/SARIF/CycloneDX), SemVer, and MSRV (`1.90`+) |
|
|
174
|
+
| [SECURITY.md](SECURITY.md) | Vulnerability reporting and CargoScope's offline/no-execution threat model |
|
|
175
|
+
| [tests/corpus/README.md](tests/corpus/README.md) | Benchmarks against `rustc`, `cargo-audit`, `cargo-deny`, `cargo-shear`, and `cargo-machete` |
|
|
176
|
+
| [SPEC.md](SPEC.md) & [CHANGELOG.md](CHANGELOG.md) | Full specification, roadmap (`0.1`–`1.0`), and release history |
|
|
177
|
+
|
|
178
|
+
## Contributing & License
|
|
179
|
+
|
|
180
|
+
Contributions and false-positive reports are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md) or open a note on the [feedback issue](https://github.com/HarpeLm/CargoScope/issues/1).
|
|
181
|
+
|
|
182
|
+
```sh
|
|
183
|
+
cargo test --workspace
|
|
184
|
+
cargo clippy --workspace --all-targets -- -D warnings
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
Licensed under the [MIT License](LICENSE).
|
|
188
|
+
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
cargoscope-0.9.1.data/scripts/cargoscope.exe,sha256=bQxvzLTwTkIpAJ0xq21VX1cPF_IphRlj16dCcfi7BV8,10722816
|
|
2
|
+
cargoscope-0.9.1.dist-info/METADATA,sha256=ILBc-sMKv_xgAaQ4kDtuGi_xxUyXuYMRhyg67ruHQTU,10135
|
|
3
|
+
cargoscope-0.9.1.dist-info/WHEEL,sha256=Uvw7WSmy7Kj2FBk8Va4L_dq4MDW8X5Ynby-pOX3ZNS0,94
|
|
4
|
+
cargoscope-0.9.1.dist-info/sboms/cargoscope.cyclonedx.json,sha256=rH7fBfadIQtXUufI7B-za0iobS8z0DtIYkFIduN_rAI,124415
|
|
5
|
+
cargoscope-0.9.1.dist-info/RECORD,,
|