ugraph-kit 0.1.0__tar.gz

ugraph_kit-0.1.0/LICENSE

@@ -0,0 +1,158 @@
+                                 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 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 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 for
+      the Work 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, but it is your responsibility
+          to ensure that the NOTICE file does not contain any additional
+          attribution notices.
+
+      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 specifically notified
+      that You may not use this software in violation of any applicable
+      laws or regulations. Aggregation of this Work with Derivative Works
+      for any purpose, however, shall be limited to your personal,
+      non-commercial use.
+
+   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 [yyyy] [name of copyright owner]
+
+   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.

ugraph_kit-0.1.0/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.4
+Name: ugraph-kit
+Version: 0.1.0
+Summary: Build an agent-navigable, citation-verified knowledge base from sources you trust.
+Author-email: saran-io <saran@tekvo.io>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://ugraph.build
+Project-URL: Repository, https://github.com/tekvo-ai/app_ugraph_kit
+Project-URL: Issues, https://github.com/tekvo-ai/app_ugraph_kit/issues
+Project-URL: Changelog, https://github.com/tekvo-ai/app_ugraph_kit/blob/main/CHANGELOG.md
+Keywords: knowledge-base,obsidian,ai,cli,provenance
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-frontmatter>=1.0.0
+Requires-Dist: tomli>=2.0.1; python_version < "3.11"
+Requires-Dist: yt-dlp>=2025.1.15
+Provides-Extra: api
+Requires-Dist: anthropic>=0.34.0; extra == "api"
+Requires-Dist: openai>=1.30.0; extra == "api"
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2; extra == "dev"
+Requires-Dist: mypy>=1.11; extra == "dev"
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: twine>=6.0.0; extra == "dev"
+Dynamic: license-file
+
+# ugraph
+
+[![ci](https://github.com/tekvo-ai/app_ugraph_kit/actions/workflows/ci.yml/badge.svg)](https://github.com/tekvo-ai/app_ugraph_kit/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/ugraph-kit.svg)](https://pypi.org/project/ugraph-kit/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+Turn any CLI input — clipboard, paste, pipe, file, or URL — into a
+filesystem-native knowledge base that Obsidian and agents can read. Raw sources
+remain inspectable, chunk IDs are content-addressed, and extracted quotes are
+checked against source text before they become candidates.
+
+> **Alpha:** the ingestion foundation is usable; retrieval and the evaluation
+> harness are still under active development.
+
+## Install
+
+The distribution is named `ugraph-kit` because `ugraph` is already taken on
+PyPI. The installed command is still the short form: `ugraph`.
+
+```bash
+# Recommended: isolated command-line install
+uv tool install ugraph-kit
+
+# Or with pipx
+pipx install ugraph-kit
+```
+
+To use Anthropic or OpenAI synthesis:
+
+```bash
+uv tool install "ugraph-kit[api]"
+# pipx install "ugraph-kit[api]" also works
+```
+
+Python 3.10+ is required.
+
+## First run
+
+Create a knowledge folder inside an Obsidian vault (or anywhere on disk):
+
+```bash
+ugraph init ~/Documents/MyVault/knowledge
+```
+
+That is the whole setup. `init` remembers the folder for this machine, so every
+later session finds it from any directory — no `--kb`, no environment variable:
+
+```bash
+cd /anywhere
+ugraph status        # works
+```
+
+To point at a different knowledge base later:
+
+```bash
+ugraph use ~/other/knowledge   # remembered from then on
+ugraph use                     # print the current one
+```
+
+Anything that describes the current invocation still wins over the remembered
+default, in this order: `--kb` → `UGRAPH_KB` → the nearest `ugraph.toml` → standing
+inside a knowledge base → the remembered one.
+
+Copy some text and run:
+
+```bash
+ugraph
+```
+
+On macOS and supported Linux desktops, ugraph reads the clipboard. Otherwise it
+prompts for a paste terminated by Ctrl+D. Piped input is always supported:
+
+```bash
+printf 'Hybrid retrieval combines lexical and semantic search.' | ugraph
+```
+
+## Add a person
+
+Copy a profile or talk URL (or paste a bio) and run `ugraph`. It previews the
+detected identity and asks before writing.
+
+The explicit, scriptable form is:
+
+```bash
+ugraph person "https://example.com/about"
+ugraph person "https://example.com/about" --yes
+```
+
+This creates:
+
+- `entities/people/<name>.md` — the canonical, minimally verified person page
+- `resources/people/<name>.md` — a compatibility redirect for existing vaults
+
+Repeating the command does not duplicate the person or overwrite
+human-authored canonical content.
+
+## Model setup
+
+Capture and person resolution do not require an LLM. Synthesis is optional:
+
+```bash
+ugraph auth set anthropic
+ugraph auth use anthropic
+
+# or
+ugraph auth set openai
+ugraph auth use openai
+
+# or a running local Ollama installation
+ugraph auth use ollama
+```
+
+Check the active configuration with `ugraph auth status`.
+
+### Tuning the model
+
+Everything about the model is configuration, not code. In `ugraph.toml`:
+
+```toml
+[extract]
+model = "claude-opus-5"  # any model, including ones released after this version
+```
+
+**A model ID selects its own backend.** `claude-*` goes to Anthropic, `gpt-*`/`o*` to
+OpenAI, and anything else is treated as a local Ollama model — so a model released
+tomorrow works without a code change or an entry in a list. Set `backend` explicitly
+only to override that:
+
+```toml
+[extract]
+backend = "api"   # api | ollama | claude-code
+```
+
+Naming a model whose provider you have no key for is refused by name rather than
+silently sent to the other provider.
+
+Token budgets are **discovered, not hardcoded**. ugraph asks your provider what the
+model accepts and caches the answer for a day, so switching models needs no code
+change and no setting. Override only if you want a tighter ceiling than the model's:
+
+```toml
+[extract]
+max_tokens = 48000   # optional — omit to use the model's own maximum
+thinking = "adaptive"  # optional — adaptive | disabled (Anthropic)
+effort = "medium"      # optional — low | medium | high | xhigh | max (Anthropic)
+temperature = 0.1      # optional — omitted by default
+```
+
+Every one of these is unset by default, which means "whatever the provider does". If
+the provider cannot be reached to report its limits, the budget is derived from the
+size of the prompt rather than guessed.
+
+## Other commands
+
+```bash
+ugraph --kb ./knowledge ingest file ./note.md
+printf 'a claim you care about' | ugraph --kb ./knowledge --yes
+ugraph ps
+ugraph logs
+ugraph lint
+ugraph verify
+```
+
+`--kb` is a global option and therefore comes before the subcommand.
+Alternatively set `UGRAPH_KB` once or run inside a configured knowledge base.
+
+## Reliability contract
+
+The current test suite enforces:
+
+1. Re-ingesting the same document creates no duplicates.
+2. Editing a document updates only affected chunks.
+3. Interrupting ingestion and rerunning completes cleanly.
+4. Model quotes must occur verbatim in their source chunk.
+5. Person capture is idempotent and preserves existing human content.
+
+Operational events are appended to `runs.jsonl` and exposed through
+`ugraph ps` and `ugraph logs`.
+
+## Source
+
+Canonical repo (Tekvo open source): https://github.com/tekvo-ai/app_ugraph_kit
+
+This is the Tekvo AI open-source home for ugraph.  
+Site: https://ugraph.build
+
+## Development
+
+```bash
+git clone https://github.com/tekvo-ai/app_ugraph_kit.git
+cd app_ugraph_kit
+uv sync --extra dev
+uv run pytest
+uv build
+```
+
+Project artifacts:
+
+- `docs/PRODUCT.md` — **product home**: goal, features, roadmap, public product log
+- `CLAIMS.md` — claims backed by tests, ADRs, or measured runs
+- `docs/adr/` — architecture decision records
+- `docs/techniques/` — just-in-time technique scans
+- `docs/releasing.md` — PyPI publish steps
+- `CONTRIBUTING.md` — dev setup and the checks CI runs
+- `CHANGELOG.md` — what changed, per release
+- `eval/` — evaluation harness work
+- `corpus/manifest.json` — loaded real-world data
+
+Licensed under Apache-2.0.

ugraph_kit-0.1.0/README.md

@@ -0,0 +1,209 @@
+# ugraph
+
+[![ci](https://github.com/tekvo-ai/app_ugraph_kit/actions/workflows/ci.yml/badge.svg)](https://github.com/tekvo-ai/app_ugraph_kit/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/ugraph-kit.svg)](https://pypi.org/project/ugraph-kit/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+Turn any CLI input — clipboard, paste, pipe, file, or URL — into a
+filesystem-native knowledge base that Obsidian and agents can read. Raw sources
+remain inspectable, chunk IDs are content-addressed, and extracted quotes are
+checked against source text before they become candidates.
+
+> **Alpha:** the ingestion foundation is usable; retrieval and the evaluation
+> harness are still under active development.
+
+## Install
+
+The distribution is named `ugraph-kit` because `ugraph` is already taken on
+PyPI. The installed command is still the short form: `ugraph`.
+
+```bash
+# Recommended: isolated command-line install
+uv tool install ugraph-kit
+
+# Or with pipx
+pipx install ugraph-kit
+```
+
+To use Anthropic or OpenAI synthesis:
+
+```bash
+uv tool install "ugraph-kit[api]"
+# pipx install "ugraph-kit[api]" also works
+```
+
+Python 3.10+ is required.
+
+## First run
+
+Create a knowledge folder inside an Obsidian vault (or anywhere on disk):
+
+```bash
+ugraph init ~/Documents/MyVault/knowledge
+```
+
+That is the whole setup. `init` remembers the folder for this machine, so every
+later session finds it from any directory — no `--kb`, no environment variable:
+
+```bash
+cd /anywhere
+ugraph status        # works
+```
+
+To point at a different knowledge base later:
+
+```bash
+ugraph use ~/other/knowledge   # remembered from then on
+ugraph use                     # print the current one
+```
+
+Anything that describes the current invocation still wins over the remembered
+default, in this order: `--kb` → `UGRAPH_KB` → the nearest `ugraph.toml` → standing
+inside a knowledge base → the remembered one.
+
+Copy some text and run:
+
+```bash
+ugraph
+```
+
+On macOS and supported Linux desktops, ugraph reads the clipboard. Otherwise it
+prompts for a paste terminated by Ctrl+D. Piped input is always supported:
+
+```bash
+printf 'Hybrid retrieval combines lexical and semantic search.' | ugraph
+```
+
+## Add a person
+
+Copy a profile or talk URL (or paste a bio) and run `ugraph`. It previews the
+detected identity and asks before writing.
+
+The explicit, scriptable form is:
+
+```bash
+ugraph person "https://example.com/about"
+ugraph person "https://example.com/about" --yes
+```
+
+This creates:
+
+- `entities/people/<name>.md` — the canonical, minimally verified person page
+- `resources/people/<name>.md` — a compatibility redirect for existing vaults
+
+Repeating the command does not duplicate the person or overwrite
+human-authored canonical content.
+
+## Model setup
+
+Capture and person resolution do not require an LLM. Synthesis is optional:
+
+```bash
+ugraph auth set anthropic
+ugraph auth use anthropic
+
+# or
+ugraph auth set openai
+ugraph auth use openai
+
+# or a running local Ollama installation
+ugraph auth use ollama
+```
+
+Check the active configuration with `ugraph auth status`.
+
+### Tuning the model
+
+Everything about the model is configuration, not code. In `ugraph.toml`:
+
+```toml
+[extract]
+model = "claude-opus-5"  # any model, including ones released after this version
+```
+
+**A model ID selects its own backend.** `claude-*` goes to Anthropic, `gpt-*`/`o*` to
+OpenAI, and anything else is treated as a local Ollama model — so a model released
+tomorrow works without a code change or an entry in a list. Set `backend` explicitly
+only to override that:
+
+```toml
+[extract]
+backend = "api"   # api | ollama | claude-code
+```
+
+Naming a model whose provider you have no key for is refused by name rather than
+silently sent to the other provider.
+
+Token budgets are **discovered, not hardcoded**. ugraph asks your provider what the
+model accepts and caches the answer for a day, so switching models needs no code
+change and no setting. Override only if you want a tighter ceiling than the model's:
+
+```toml
+[extract]
+max_tokens = 48000   # optional — omit to use the model's own maximum
+thinking = "adaptive"  # optional — adaptive | disabled (Anthropic)
+effort = "medium"      # optional — low | medium | high | xhigh | max (Anthropic)
+temperature = 0.1      # optional — omitted by default
+```
+
+Every one of these is unset by default, which means "whatever the provider does". If
+the provider cannot be reached to report its limits, the budget is derived from the
+size of the prompt rather than guessed.
+
+## Other commands
+
+```bash
+ugraph --kb ./knowledge ingest file ./note.md
+printf 'a claim you care about' | ugraph --kb ./knowledge --yes
+ugraph ps
+ugraph logs
+ugraph lint
+ugraph verify
+```
+
+`--kb` is a global option and therefore comes before the subcommand.
+Alternatively set `UGRAPH_KB` once or run inside a configured knowledge base.
+
+## Reliability contract
+
+The current test suite enforces:
+
+1. Re-ingesting the same document creates no duplicates.
+2. Editing a document updates only affected chunks.
+3. Interrupting ingestion and rerunning completes cleanly.
+4. Model quotes must occur verbatim in their source chunk.
+5. Person capture is idempotent and preserves existing human content.
+
+Operational events are appended to `runs.jsonl` and exposed through
+`ugraph ps` and `ugraph logs`.
+
+## Source
+
+Canonical repo (Tekvo open source): https://github.com/tekvo-ai/app_ugraph_kit
+
+This is the Tekvo AI open-source home for ugraph.  
+Site: https://ugraph.build
+
+## Development
+
+```bash
+git clone https://github.com/tekvo-ai/app_ugraph_kit.git
+cd app_ugraph_kit
+uv sync --extra dev
+uv run pytest
+uv build
+```
+
+Project artifacts:
+
+- `docs/PRODUCT.md` — **product home**: goal, features, roadmap, public product log
+- `CLAIMS.md` — claims backed by tests, ADRs, or measured runs
+- `docs/adr/` — architecture decision records
+- `docs/techniques/` — just-in-time technique scans
+- `docs/releasing.md` — PyPI publish steps
+- `CONTRIBUTING.md` — dev setup and the checks CI runs
+- `CHANGELOG.md` — what changed, per release
+- `eval/` — evaluation harness work
+- `corpus/manifest.json` — loaded real-world data
+
+Licensed under Apache-2.0.