llm-api-scope 0.2.0__tar.gz → 0.3.0__tar.gz

llm_api_scope-0.3.0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: llm-api-scope
+Version: 0.3.0
+Summary: Command-line tool for LLMs to quickly search and understand OpenAPI endpoints
+Author-email: D7x7z49 <85430783+D7x7z49@users.noreply.github.com>
+License: MIT License
+        
+        Copyright (c) 2026 D7x7z49
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/D7x7z49/llm-api-scope
+Project-URL: Repository, https://github.com/D7x7z49/llm-api-scope.git
+Project-URL: Issues, https://github.com/D7x7z49/llm-api-scope/issues
+Keywords: openapi,api,cli,llm,swagger,endpoint,search
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Requires-Python: <4.0,>=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.3.1
+Requires-Dist: openapi-core>=0.22.0
+Requires-Dist: httpx>=0.28.1
+Dynamic: license-file
+
+# LLM API Scope (apiscope)
+
+A command-line tool designed for Large Language Models (LLMs) and developers to index, search, and query structured API documentation (e.g., OpenAPI specifications). It assists LLMs in obtaining API information quickly and accurately within automated workflows.
+
+## Installation
+
+apiscope is a command-line tool, not a Python library. For isolated installation without affecting your system Python, we recommend using pipx:
+
+```bash
+# don't use pip
+pipx install llm-api-scope
+```
+
+## Command Usage
+
+### `apiscope init`
+Initialize the project by creating a configuration file (`apiscope.ini`) and cache directory (`.apiscope/cache/`). It automatically adds `.apiscope/` to your project's `.gitignore`.
+
+### `apiscope list`
+List all configured API specifications by displaying the `<name> = <source>` pairs from the configuration file.
+
+### `apiscope search <name> <keywords> [--force]`
+Search within a specific API specification (`<name>`) for endpoints matching the given keywords. Returns the total count and displays up to 10 matching `<path>:<method>` identifiers.
+
+### `apiscope describe <name> <path:method> [--force]`
+Generate and output a concise Markdown guide for using the specified endpoint (`<path:method>`) from the API specification (`<name>`). The guide includes essential calling information such as parameters, request body, and response structure.
+
+### `apiscope note`
+Manage reflective notes for agent reasoning and knowledge capture. This command provides a structured notebook system with six cognitive note types: Observation (OBS), Reasoning (REA), Action (ACT), Reflection (REF), Question (QUE), and Inspiration (INS).
+
+Available subcommands:
+- `auth`: Establish and manage agent identity authentication through three philosophical dimensions (Name, Role, Story). Required before creating notes to ensure the agent has a defined sense of self.
+- `write`: Create a new note with specified author and type (uses two-phase write mechanism)
+- `read`: Display notes for a specific author with pagination and size limits
+- `add`: Append annotations (REFERENCE, NOTE, or TIP) to existing notes
+- `stats`: Analyze note-taking patterns, temporal concentration, and thinking segments
+- `readme`: Display comprehensive documentation about the note system
+
+Notes are stored in `.apiscope/notes/` with automatic organization by author and timestamp. The system supports pattern recognition for classical thinking sequences like Empirical Induction, Hypothetico-Deductive reasoning, and Experimental Science. For complete documentation, run `apiscope note readme`.

llm_api_scope-0.2.0/llm_api_scope.egg-info/PKG-INFO → llm_api_scope-0.3.0/README.md

@@ -1,17 +1,3 @@
-Metadata-Version: 2.4
-Name: llm-api-scope
-Version: 0.2.0
-Summary: Default template for PDM package
-Author-email: D7x7z49 <85430783+D7x7z49@users.noreply.github.com>
-License: MIT
-Requires-Python: <4.0,>=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: click>=8.3.1
-Requires-Dist: openapi-core>=0.22.0
-Requires-Dist: httpx>=0.28.1
-Dynamic: license-file
-
 # LLM API Scope (apiscope)
 
 A command-line tool designed for Large Language Models (LLMs) and developers to index, search, and query structured API documentation (e.g., OpenAPI specifications). It assists LLMs in obtaining API information quickly and accurately within automated workflows.
@@ -38,3 +24,16 @@ Search within a specific API specification (`<name>`) for endpoints matching the
 
 ### `apiscope describe <name> <path:method> [--force]`
 Generate and output a concise Markdown guide for using the specified endpoint (`<path:method>`) from the API specification (`<name>`). The guide includes essential calling information such as parameters, request body, and response structure.
+
+### `apiscope note`
+Manage reflective notes for agent reasoning and knowledge capture. This command provides a structured notebook system with six cognitive note types: Observation (OBS), Reasoning (REA), Action (ACT), Reflection (REF), Question (QUE), and Inspiration (INS).
+
+Available subcommands:
+- `auth`: Establish and manage agent identity authentication through three philosophical dimensions (Name, Role, Story). Required before creating notes to ensure the agent has a defined sense of self.
+- `write`: Create a new note with specified author and type (uses two-phase write mechanism)
+- `read`: Display notes for a specific author with pagination and size limits
+- `add`: Append annotations (REFERENCE, NOTE, or TIP) to existing notes
+- `stats`: Analyze note-taking patterns, temporal concentration, and thinking segments
+- `readme`: Display comprehensive documentation about the note system
+
+Notes are stored in `.apiscope/notes/` with automatic organization by author and timestamp. The system supports pattern recognition for classical thinking sequences like Empirical Induction, Hypothetico-Deductive reasoning, and Experimental Science. For complete documentation, run `apiscope note readme`.

{llm_api_scope-0.2.0 → llm_api_scope-0.3.0}/apiscope/cli.py

@@ -6,6 +6,7 @@ from .commands.init import init_command
 from .commands.list import list_command
 from .commands.search import search_command
 from .commands.describe import describe_command
+from .commands.note import note_command
 
 
 @click.group()
@@ -30,6 +31,7 @@ cli.add_command(init_command, name="init")
 cli.add_command(list_command, name="list")
 cli.add_command(search_command, name="search")
 cli.add_command(describe_command, name="describe")
+cli.add_command(note_command, name="note")
 
 if __name__ == "__main__":
     cli()

llm_api_scope-0.3.0/apiscope/commands/note/__init__.py

@@ -0,0 +1,2 @@
+"""Note command package for apiscope."""
+from .commands import note_command