llm-api-scope 0.7.0__tar.gz → 0.8.0__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.
Files changed (39) hide show
  1. {llm_api_scope-0.7.0/llm_api_scope.egg-info → llm_api_scope-0.8.0}/PKG-INFO +12 -1
  2. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/README.md +11 -0
  3. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/skill/_usage.py +3 -0
  4. llm_api_scope-0.8.0/apiscope/skill/app.py +50 -0
  5. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/skill/docs.py +30 -0
  6. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0/llm_api_scope.egg-info}/PKG-INFO +12 -1
  7. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/pyproject.toml +1 -1
  8. llm_api_scope-0.7.0/apiscope/skill/app.py +0 -19
  9. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/LICENSE +0 -0
  10. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/__init__.py +0 -0
  11. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/config.py +0 -0
  12. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/main.py +0 -0
  13. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/openapi/__init__.py +0 -0
  14. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/openapi/app.py +0 -0
  15. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/openapi/fetch.py +0 -0
  16. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/openapi/reader.py +0 -0
  17. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/openapi/schema.py +0 -0
  18. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/openapi/spec/__init__.py +0 -0
  19. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/openapi/spec/app.py +0 -0
  20. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/openapi/spec/schema.py +0 -0
  21. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/repo/__init__.py +0 -0
  22. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/repo/app.py +0 -0
  23. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/repo/fetch.py +0 -0
  24. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/repo/schema.py +0 -0
  25. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/rfc/__init__.py +0 -0
  26. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/rfc/app.py +0 -0
  27. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/rfc/fetch.py +0 -0
  28. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/rfc/parse_txt.py +0 -0
  29. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/rfc/parse_xml.py +0 -0
  30. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/rfc/schema.py +0 -0
  31. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/rfc/search.py +0 -0
  32. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/schema.py +0 -0
  33. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/apiscope/skill/__init__.py +0 -0
  34. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/llm_api_scope.egg-info/SOURCES.txt +0 -0
  35. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/llm_api_scope.egg-info/dependency_links.txt +0 -0
  36. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/llm_api_scope.egg-info/entry_points.txt +0 -0
  37. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/llm_api_scope.egg-info/requires.txt +0 -0
  38. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/llm_api_scope.egg-info/top_level.txt +0 -0
  39. {llm_api_scope-0.7.0 → llm_api_scope-0.8.0}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: llm-api-scope
3
- Version: 0.7.0
3
+ Version: 0.8.0
4
4
  Summary: read and cache structured documents from remote for LLM agents
5
5
  Author-email: D7x7z49 <85430783+D7x7z49@users.noreply.github.com>
6
6
  License: MIT License
@@ -79,6 +79,17 @@ read, search, and navigate RFC documents from the IETF.
79
79
 
80
80
  the metadata index is mirrored once via rsync. individual text files are fetched on demand and cached locally. you can browse the table of contents, jump to a section (XML) or page (TXT), filter the index by status or source, and run keyword searches against fulltext content.
81
81
 
82
+ ### skill
83
+
84
+ output a combined command reference and strategy guide for AI agents.
85
+
86
+ run `apiscope skill` to get a single document that covers every subcommand and
87
+ how they fit together. the strategy guide classifies commands into management and
88
+ usage groups, lists prerequisites in ABNF (RFC 5234), and provides workflow
89
+ patterns with requirement levels (RFC 2119).
90
+
91
+ agents read this output once at onboarding instead of running `--help` repeatedly.
92
+
82
93
  ### repo
83
94
 
84
95
  sync documentation directories from any git repository to a local cache.
@@ -30,6 +30,17 @@ read, search, and navigate RFC documents from the IETF.
30
30
 
31
31
  the metadata index is mirrored once via rsync. individual text files are fetched on demand and cached locally. you can browse the table of contents, jump to a section (XML) or page (TXT), filter the index by status or source, and run keyword searches against fulltext content.
32
32
 
33
+ ### skill
34
+
35
+ output a combined command reference and strategy guide for AI agents.
36
+
37
+ run `apiscope skill` to get a single document that covers every subcommand and
38
+ how they fit together. the strategy guide classifies commands into management and
39
+ usage groups, lists prerequisites in ABNF (RFC 5234), and provides workflow
40
+ patterns with requirement levels (RFC 2119).
41
+
42
+ agents read this output once at onboarding instead of running `--help` repeatedly.
43
+
33
44
  ### repo
34
45
 
35
46
  sync documentation directories from any git repository to a local cache.
@@ -69,4 +69,7 @@ USAGE_TEXT = """\
69
69
  - list # list registered repos
70
70
  - sync # sync all registered repos to cache
71
71
  + [--force]? # force re-sync ignoring cache TTL
72
+ - skill # output usage guide for ai agents
73
+ - install # install SKILL.md for code agent
74
+ + [TARGET]? # install directory (default: ~/.agents/skills)
72
75
  """
@@ -0,0 +1,50 @@
1
+ # apiscope/skill/app.py
2
+
3
+ from pathlib import Path
4
+
5
+ import typer
6
+
7
+ from apiscope.skill._usage import USAGE_TEXT
8
+ from apiscope.skill.docs import INSTALL_MD, STRATEGY_GUIDE
9
+
10
+ app = typer.Typer(help="output usage guide for ai agents")
11
+
12
+
13
+ # ==============================================================================
14
+ # callback
15
+ # ==============================================================================
16
+
17
+
18
+ @app.callback(invoke_without_command=True)
19
+ def skill_callback(ctx: typer.Context) -> None:
20
+ if ctx.invoked_subcommand is not None:
21
+ return
22
+
23
+ typer.echo("=== COMMAND REFERENCE ===")
24
+ typer.echo()
25
+ typer.echo(USAGE_TEXT)
26
+ typer.echo()
27
+ typer.echo("=== STRATEGY GUIDE ===")
28
+ typer.echo()
29
+ typer.echo(STRATEGY_GUIDE)
30
+
31
+
32
+ # ==============================================================================
33
+ # commands
34
+ # ==============================================================================
35
+
36
+
37
+ @app.command(name="install", help="install SKILL.md for code agent")
38
+ def install(
39
+ target: str | None = typer.Argument(None, help="install directory (default: ~/.agents/skills)"),
40
+ ) -> None:
41
+ if target is None:
42
+ target = str(Path.home() / ".agents" / "skills")
43
+
44
+ target_path = Path(target).expanduser().resolve()
45
+ skill_path = target_path / "apiscope" / "SKILL.md"
46
+
47
+ skill_path.parent.mkdir(parents=True, exist_ok=True)
48
+ skill_path.write_text(INSTALL_MD)
49
+
50
+ typer.echo(f"installed: {skill_path}")
@@ -109,3 +109,33 @@ TIPS
109
109
  first to scan endpoints, then [describe] to extract a
110
110
  specific operation in detail.
111
111
  """
112
+
113
+
114
+ INSTALL_MD = """\
115
+ ---
116
+ name: apiscope
117
+ description: >-
118
+ Query OpenAPI specs, IETF RFCs, and synced git repo docs.
119
+ Use when searching API references, RFC standards,
120
+ or documentation of registered repos.
121
+ ---
122
+
123
+ `apiscope` reads network resources to local cache.
124
+ it covers openapi specs, ietf rfc documents, and git repo docs.
125
+
126
+ discover commands with `--help`.
127
+ `apiscope --help`
128
+ `apiscope <sub> --help`
129
+
130
+ read the full strategy guide.
131
+ `apiscope skill`
132
+
133
+ find cached repo paths.
134
+ `apiscope repo list`
135
+
136
+ search cached docs.
137
+ `rg <term> <cache-path>`
138
+
139
+ prefer cached docs.
140
+ use `--force` only when remote has changed.
141
+ """
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: llm-api-scope
3
- Version: 0.7.0
3
+ Version: 0.8.0
4
4
  Summary: read and cache structured documents from remote for LLM agents
5
5
  Author-email: D7x7z49 <85430783+D7x7z49@users.noreply.github.com>
6
6
  License: MIT License
@@ -79,6 +79,17 @@ read, search, and navigate RFC documents from the IETF.
79
79
 
80
80
  the metadata index is mirrored once via rsync. individual text files are fetched on demand and cached locally. you can browse the table of contents, jump to a section (XML) or page (TXT), filter the index by status or source, and run keyword searches against fulltext content.
81
81
 
82
+ ### skill
83
+
84
+ output a combined command reference and strategy guide for AI agents.
85
+
86
+ run `apiscope skill` to get a single document that covers every subcommand and
87
+ how they fit together. the strategy guide classifies commands into management and
88
+ usage groups, lists prerequisites in ABNF (RFC 5234), and provides workflow
89
+ patterns with requirement levels (RFC 2119).
90
+
91
+ agents read this output once at onboarding instead of running `--help` repeatedly.
92
+
82
93
  ### repo
83
94
 
84
95
  sync documentation directories from any git repository to a local cache.
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "llm-api-scope"
7
- version = "0.7.0"
7
+ version = "0.8.0"
8
8
  description = "read and cache structured documents from remote for LLM agents"
9
9
  readme = "README.md"
10
10
  license = { file = "LICENSE" }
@@ -1,19 +0,0 @@
1
- # apiscope/skill/app.py
2
-
3
- import typer
4
-
5
- from apiscope.skill._usage import USAGE_TEXT
6
- from apiscope.skill.docs import STRATEGY_GUIDE
7
-
8
- app = typer.Typer(help="output usage guide for ai agents")
9
-
10
-
11
- @app.callback(invoke_without_command=True)
12
- def skill_callback() -> None:
13
- typer.echo("=== COMMAND REFERENCE ===")
14
- typer.echo()
15
- typer.echo(USAGE_TEXT)
16
- typer.echo()
17
- typer.echo("=== STRATEGY GUIDE ===")
18
- typer.echo()
19
- typer.echo(STRATEGY_GUIDE)
File without changes
File without changes