skillplus 0.1.1__tar.gz → 0.1.2__tar.gz

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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: skillplus
3
- Version: 0.1.1
3
+ Version: 0.1.2
4
4
  Summary: Official Python SDK for SkillPlus
5
5
  Project-URL: Homepage, https://skillplus.xyz
6
6
  Project-URL: Documentation, https://docs.skillplus.xyz
@@ -30,37 +30,38 @@ pip install skillplus
30
30
 
31
31
  Requires Python 3.10+.
32
32
 
33
- ## Basic usage
33
+ ## Quick start
34
+
35
+ One call that always ends with a completed report — scanning first if the
36
+ skill has never been seen:
34
37
 
35
38
  ```python
36
39
  from skillplus import SkillPlus
37
40
 
38
41
  client = SkillPlus(api_key="skp_...")
39
42
 
40
- result = client.query("https://www.skills.sh/vercel-labs/skills/find-skills")
43
+ report = client.wait_for_report("https://www.skills.sh/vercel-labs/skills/find-skills")
41
44
  # GitHub repositories work the same way: "https://github.com/owner/repo"
42
45
 
43
- if result.status == "found" and result.report:
44
- print(result.report.verdict) # "safe" | "medium" | "high" | "unknown"
46
+ print(report.verdict) # "safe" | "medium" | "high" | "unknown" — UI labels: Safe / Caution / High Risk / Unrated
47
+ print(report.summary.total_issues)
48
+ if report.supply_chain:
49
+ print(report.supply_chain.blacklist_hits) # poisoned-dependency hits
45
50
  ```
46
51
 
47
52
  Prefer `verdict` over the legacy `rating` field — it folds historical values
48
- onto the current three-tier scale (UI labels: safe→Safe, medium→Caution,
49
- high→High Risk, unknown→Unrated).
53
+ onto the current three-tier scale.
50
54
 
51
- ## One call that always ends with a report
55
+ ## Lower-level: check without waiting
52
56
 
53
- When you just want the final answer scanning first if the skill has never
54
- been seen use the wait helper. It polls internally and returns the
55
- completed report:
57
+ `query` returns immediately with the current state (`found` / `queued` /
58
+ `running` / `not_found` / `failed`) and never blocks:
56
59
 
57
60
  ```python
58
- report = client.wait_for_report("https://www.skills.sh/vercel-labs/skills/find-skills")
61
+ result = client.query("https://www.skills.sh/vercel-labs/skills/find-skills")
59
62
 
60
- print(report.verdict)
61
- print(report.summary.total_issues)
62
- if report.supply_chain:
63
- print(report.supply_chain.blacklist_hits) # poisoned-dependency hits
63
+ if result.status == "found" and result.report:
64
+ print(result.report.verdict)
64
65
  ```
65
66
 
66
67
  ## Advanced options
@@ -12,37 +12,38 @@ pip install skillplus
12
12
 
13
13
  Requires Python 3.10+.
14
14
 
15
- ## Basic usage
15
+ ## Quick start
16
+
17
+ One call that always ends with a completed report — scanning first if the
18
+ skill has never been seen:
16
19
 
17
20
  ```python
18
21
  from skillplus import SkillPlus
19
22
 
20
23
  client = SkillPlus(api_key="skp_...")
21
24
 
22
- result = client.query("https://www.skills.sh/vercel-labs/skills/find-skills")
25
+ report = client.wait_for_report("https://www.skills.sh/vercel-labs/skills/find-skills")
23
26
  # GitHub repositories work the same way: "https://github.com/owner/repo"
24
27
 
25
- if result.status == "found" and result.report:
26
- print(result.report.verdict) # "safe" | "medium" | "high" | "unknown"
28
+ print(report.verdict) # "safe" | "medium" | "high" | "unknown" — UI labels: Safe / Caution / High Risk / Unrated
29
+ print(report.summary.total_issues)
30
+ if report.supply_chain:
31
+ print(report.supply_chain.blacklist_hits) # poisoned-dependency hits
27
32
  ```
28
33
 
29
34
  Prefer `verdict` over the legacy `rating` field — it folds historical values
30
- onto the current three-tier scale (UI labels: safe→Safe, medium→Caution,
31
- high→High Risk, unknown→Unrated).
35
+ onto the current three-tier scale.
32
36
 
33
- ## One call that always ends with a report
37
+ ## Lower-level: check without waiting
34
38
 
35
- When you just want the final answer scanning first if the skill has never
36
- been seen use the wait helper. It polls internally and returns the
37
- completed report:
39
+ `query` returns immediately with the current state (`found` / `queued` /
40
+ `running` / `not_found` / `failed`) and never blocks:
38
41
 
39
42
  ```python
40
- report = client.wait_for_report("https://www.skills.sh/vercel-labs/skills/find-skills")
43
+ result = client.query("https://www.skills.sh/vercel-labs/skills/find-skills")
41
44
 
42
- print(report.verdict)
43
- print(report.summary.total_issues)
44
- if report.supply_chain:
45
- print(report.supply_chain.blacklist_hits) # poisoned-dependency hits
45
+ if result.status == "found" and result.report:
46
+ print(result.report.verdict)
46
47
  ```
47
48
 
48
49
  ## Advanced options
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "skillplus"
7
- version = "0.1.1"
7
+ version = "0.1.2"
8
8
  description = "Official Python SDK for SkillPlus"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.10"
@@ -50,7 +50,7 @@ class SkillPlus:
50
50
  headers={
51
51
  "Authorization": f"Bearer {api_key}",
52
52
  "Content-Type": "application/json",
53
- "User-Agent": "skillplus-python/0.1.1",
53
+ "User-Agent": "skillplus-python/0.1.2",
54
54
  },
55
55
  )
56
56
 
File without changes
File without changes