okf-toolkit 0.1.0__tar.gz

okf-toolkit-0.1.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 [2026] [okf-toolkit contributors]
+
+   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.

okf-toolkit-0.1.0/PKG-INFO

@@ -0,0 +1,211 @@
+Metadata-Version: 2.1
+Name: okf-toolkit
+Version: 0.1.0
+Summary: CLI toolkit for working with Google's Open Knowledge Format (OKF)
+Home-page: https://github.com/akdira/okf-toolkit
+License: Apache 2.0
+Project-URL: Homepage, https://www.akdira.id
+Project-URL: Source, https://github.com/akdira/okf-toolkit
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Text Processing :: Markup
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# okf-toolkit
+
+**CLI toolkit for working with Google's Open Knowledge Format (OKF)**
+
+okf-toolkit is a command-line tool for creating, validating, traversing, and maintaining knowledge bases stored in the Open Knowledge Format (OKF). OKF is a vendor-neutral, human-and-agent-friendly format announced by Google Cloud on June 12, 2026. It represents knowledge as a directory tree of plain-text markdown files with YAML frontmatter, making knowledge bases portable, version-controllable, and accessible to both humans and AI agents.
+
+## What is OKF?
+
+The Open Knowledge Format is a specification for organizing structured and unstructured knowledge in a file-system-based bundle. Each unit of knowledge — a "concept" — lives in its own `.md` file with YAML frontmatter that provides typed metadata. Key principles:
+
+- **Simplicity:** Everything is markdown. No databases, no proprietary schemas.
+- **Portability:** A bundle is a directory tree. Copy it, commit it to Git, distribute it via any channel.
+- **Agent-friendly:** Typed frontmatter and clear linking make it trivial for AI agents to traverse, understand, and augment knowledge bases.
+- **Extensibility:** Producers can add any extra frontmatter keys; consumers tolerate unknown ones.
+- **UTF-8 throughout:** No encoding guesswork.
+
+## Features
+
+okf-toolkit provides everything you need to work with OKF bundles:
+
+| Command     | Description                                                                |
+|-------------|----------------------------------------------------------------------------|
+| `okf init`  | Scaffold a new OKF bundle directory with index.md and log.md               |
+| `okf new`   | Interactively create a new concept with guided frontmatter prompts        |
+| `okf validate` | Validate bundle structure: required fields, reserved names, UTF-8, links |
+| `okf list`  | List all concepts with their type and description                          |
+| `okf show`  | Display a concept's full frontmatter and body content                      |
+| `okf index` | Auto-generate or refresh index.md files from concept frontmatter           |
+| `okf search`| Full-text substring search across all concept bodies                       |
+| `okf graph` | Output the link graph as Mermaid or ASCII for visualization                |
+| `okf stats` | Bundle statistics: concept count, type breakdown, tag cloud, link counts   |
+
+## Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/openclaw/okf-toolkit.git
+cd okf-toolkit
+
+# Install the dependency
+pip install pyyaml>=6.0
+
+# (optional) Install as a package
+pip install -e .
+```
+
+Python 3.10 or newer is required. Only `pyyaml` is needed beyond the standard library.
+
+## Quick Start
+
+```bash
+# Initialize a new bundle
+okf init my-knowledge-base
+
+# Navigate into it
+cd my-knowledge-base
+
+# Create a concept interactively
+okf new . tables/user-sessions
+
+# Validate the bundle
+okf validate .
+
+# List all concepts
+okf list .
+
+# Search across concepts
+okf search . user
+
+# Generate index.md files from frontmatter
+okf index .
+
+# Show the link graph
+okf graph .
+
+# Get bundle statistics
+okf stats .
+```
+
+## Usage Examples
+
+### Creating a New Knowledge Base
+
+```bash
+okf init docs/knowledge-base
+```
+
+This creates:
+```
+docs/knowledge-base/
+├── index.md    # Directory listing (auto-editable)
+└── log.md      # Update history
+```
+
+### Adding a Concept
+
+```bash
+okf new docs/knowledge-base api/checkout-endpoint
+```
+
+You'll be prompted for:
+- `type` (required) — e.g., "API Endpoint", "BigQuery Table", "Playbook"
+- `title` (optional)
+- `description` (optional)
+- `resource` (optional URI)
+- `tags` (optional, comma-separated)
+
+The tool generates a markdown file with proper YAML frontmatter and a template body.
+
+### Validating a Bundle
+
+```bash
+okf validate docs/knowledge-base
+```
+
+Checks every `.md` file for:
+- Valid UTF-8 encoding
+- Reserved filename violations (`index.md` and `log.md` must not have a `type` field)
+- Required frontmatter fields (`type`)
+- YAML parseability
+- Broken markdown cross-links (reported as warnings)
+- Type correctness for `tags` (must be a list) and `timestamp` (must be a string)
+
+Exits with code 1 if any errors found, 0 otherwise.
+
+### Searching Across Concepts
+
+```bash
+okf search docs/knowledge-base revenue
+```
+
+Performs case-insensitive substring matching across all concept files (excluding `index.md` and `log.md`). Shows the matching file, its type, and a highlighted snippet around the match.
+
+### Generating Index Files
+
+```bash
+okf index docs/knowledge-base
+```
+
+Walks every directory containing concepts and generates or updates an `index.md` with properly formatted links, titles, types, and descriptions pulled from frontmatter. Skips directories where nothing has changed.
+
+### Visualizing the Link Graph
+
+```bash
+# Mermaid format (default) — paste into GitHub-flavored markdown
+okf graph docs/knowledge-base
+
+# ASCII format for terminal inspection
+okf graph docs/knowledge-base --format ascii
+```
+
+## Why OKF Matters for AI Agents
+
+AI agents that work with knowledge bases face two fundamental challenges: understanding the structure of the knowledge, and knowing how to add to it. OKF addresses both:
+
+1. **Typed frontmatter gives agents semantic understanding.** When an agent encounters a concept file, the `type` field immediately tells it what kind of thing this is — a table, a metric, a playbook, a reference. This reduces hallucination and improves retrieval accuracy.
+
+2. **Clear linking creates a traversable graph.** Agents can follow markdown links between concepts just like humans do, building a graph of related knowledge.
+
+3. **The format is append-friendly.** An agent that discovers new knowledge can create a new `.md` file with proper frontmatter using the same tools a human would.
+
+4. **Version control works out of the box.** Git tracks every change to every concept. Agents can see what changed, when, and why.
+
+5. **No lock-in.** Unlike a proprietary knowledge graph or database, OKF bundles are plain files. Any tool — AI or otherwise — that can read markdown and YAML can work with OKF.
+
+## Contributing
+
+Contributions are welcome! Here's how to get started:
+
+1. **Read the AGENTS.md** file in the repository root — it contains detailed instructions for AI agents and human contributors alike.
+2. **Open an issue** to discuss your proposed change before writing code.
+3. **Fork the repository** and create a feature branch.
+4. **Write tests** for any new functionality. Tests live in `tests/` and use Python's `unittest` framework.
+5. **Ensure existing tests pass** with `python3 -m unittest tests/test_okf.py -v`.
+6. **Submit a pull request** with a clear description of what and why.
+
+Conventions:
+- Python 3.10+ only, stdlib-first approach
+- `pyyaml` is the sole external dependency — keep it that way
+- New CLI commands should follow the existing pattern (see `cmd_*` functions in `okf.py`)
+- Keep ANSI color helpers in the `_color` / `green`/`red`/etc. functions
+
+## Credits
+
+Created and maintained by [akdira](https://www.akdira.id).
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE) for the full text.

okf-toolkit-0.1.0/README.md

@@ -0,0 +1,189 @@
+# okf-toolkit
+
+**CLI toolkit for working with Google's Open Knowledge Format (OKF)**
+
+okf-toolkit is a command-line tool for creating, validating, traversing, and maintaining knowledge bases stored in the Open Knowledge Format (OKF). OKF is a vendor-neutral, human-and-agent-friendly format announced by Google Cloud on June 12, 2026. It represents knowledge as a directory tree of plain-text markdown files with YAML frontmatter, making knowledge bases portable, version-controllable, and accessible to both humans and AI agents.
+
+## What is OKF?
+
+The Open Knowledge Format is a specification for organizing structured and unstructured knowledge in a file-system-based bundle. Each unit of knowledge — a "concept" — lives in its own `.md` file with YAML frontmatter that provides typed metadata. Key principles:
+
+- **Simplicity:** Everything is markdown. No databases, no proprietary schemas.
+- **Portability:** A bundle is a directory tree. Copy it, commit it to Git, distribute it via any channel.
+- **Agent-friendly:** Typed frontmatter and clear linking make it trivial for AI agents to traverse, understand, and augment knowledge bases.
+- **Extensibility:** Producers can add any extra frontmatter keys; consumers tolerate unknown ones.
+- **UTF-8 throughout:** No encoding guesswork.
+
+## Features
+
+okf-toolkit provides everything you need to work with OKF bundles:
+
+| Command     | Description                                                                |
+|-------------|----------------------------------------------------------------------------|
+| `okf init`  | Scaffold a new OKF bundle directory with index.md and log.md               |
+| `okf new`   | Interactively create a new concept with guided frontmatter prompts        |
+| `okf validate` | Validate bundle structure: required fields, reserved names, UTF-8, links |
+| `okf list`  | List all concepts with their type and description                          |
+| `okf show`  | Display a concept's full frontmatter and body content                      |
+| `okf index` | Auto-generate or refresh index.md files from concept frontmatter           |
+| `okf search`| Full-text substring search across all concept bodies                       |
+| `okf graph` | Output the link graph as Mermaid or ASCII for visualization                |
+| `okf stats` | Bundle statistics: concept count, type breakdown, tag cloud, link counts   |
+
+## Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/openclaw/okf-toolkit.git
+cd okf-toolkit
+
+# Install the dependency
+pip install pyyaml>=6.0
+
+# (optional) Install as a package
+pip install -e .
+```
+
+Python 3.10 or newer is required. Only `pyyaml` is needed beyond the standard library.
+
+## Quick Start
+
+```bash
+# Initialize a new bundle
+okf init my-knowledge-base
+
+# Navigate into it
+cd my-knowledge-base
+
+# Create a concept interactively
+okf new . tables/user-sessions
+
+# Validate the bundle
+okf validate .
+
+# List all concepts
+okf list .
+
+# Search across concepts
+okf search . user
+
+# Generate index.md files from frontmatter
+okf index .
+
+# Show the link graph
+okf graph .
+
+# Get bundle statistics
+okf stats .
+```
+
+## Usage Examples
+
+### Creating a New Knowledge Base
+
+```bash
+okf init docs/knowledge-base
+```
+
+This creates:
+```
+docs/knowledge-base/
+├── index.md    # Directory listing (auto-editable)
+└── log.md      # Update history
+```
+
+### Adding a Concept
+
+```bash
+okf new docs/knowledge-base api/checkout-endpoint
+```
+
+You'll be prompted for:
+- `type` (required) — e.g., "API Endpoint", "BigQuery Table", "Playbook"
+- `title` (optional)
+- `description` (optional)
+- `resource` (optional URI)
+- `tags` (optional, comma-separated)
+
+The tool generates a markdown file with proper YAML frontmatter and a template body.
+
+### Validating a Bundle
+
+```bash
+okf validate docs/knowledge-base
+```
+
+Checks every `.md` file for:
+- Valid UTF-8 encoding
+- Reserved filename violations (`index.md` and `log.md` must not have a `type` field)
+- Required frontmatter fields (`type`)
+- YAML parseability
+- Broken markdown cross-links (reported as warnings)
+- Type correctness for `tags` (must be a list) and `timestamp` (must be a string)
+
+Exits with code 1 if any errors found, 0 otherwise.
+
+### Searching Across Concepts
+
+```bash
+okf search docs/knowledge-base revenue
+```
+
+Performs case-insensitive substring matching across all concept files (excluding `index.md` and `log.md`). Shows the matching file, its type, and a highlighted snippet around the match.
+
+### Generating Index Files
+
+```bash
+okf index docs/knowledge-base
+```
+
+Walks every directory containing concepts and generates or updates an `index.md` with properly formatted links, titles, types, and descriptions pulled from frontmatter. Skips directories where nothing has changed.
+
+### Visualizing the Link Graph
+
+```bash
+# Mermaid format (default) — paste into GitHub-flavored markdown
+okf graph docs/knowledge-base
+
+# ASCII format for terminal inspection
+okf graph docs/knowledge-base --format ascii
+```
+
+## Why OKF Matters for AI Agents
+
+AI agents that work with knowledge bases face two fundamental challenges: understanding the structure of the knowledge, and knowing how to add to it. OKF addresses both:
+
+1. **Typed frontmatter gives agents semantic understanding.** When an agent encounters a concept file, the `type` field immediately tells it what kind of thing this is — a table, a metric, a playbook, a reference. This reduces hallucination and improves retrieval accuracy.
+
+2. **Clear linking creates a traversable graph.** Agents can follow markdown links between concepts just like humans do, building a graph of related knowledge.
+
+3. **The format is append-friendly.** An agent that discovers new knowledge can create a new `.md` file with proper frontmatter using the same tools a human would.
+
+4. **Version control works out of the box.** Git tracks every change to every concept. Agents can see what changed, when, and why.
+
+5. **No lock-in.** Unlike a proprietary knowledge graph or database, OKF bundles are plain files. Any tool — AI or otherwise — that can read markdown and YAML can work with OKF.
+
+## Contributing
+
+Contributions are welcome! Here's how to get started:
+
+1. **Read the AGENTS.md** file in the repository root — it contains detailed instructions for AI agents and human contributors alike.
+2. **Open an issue** to discuss your proposed change before writing code.
+3. **Fork the repository** and create a feature branch.
+4. **Write tests** for any new functionality. Tests live in `tests/` and use Python's `unittest` framework.
+5. **Ensure existing tests pass** with `python3 -m unittest tests/test_okf.py -v`.
+6. **Submit a pull request** with a clear description of what and why.
+
+Conventions:
+- Python 3.10+ only, stdlib-first approach
+- `pyyaml` is the sole external dependency — keep it that way
+- New CLI commands should follow the existing pattern (see `cmd_*` functions in `okf.py`)
+- Keep ANSI color helpers in the `_color` / `green`/`red`/etc. functions
+
+## Credits
+
+Created and maintained by [akdira](https://www.akdira.id).
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE) for the full text.