spikuit 0.2.0__tar.gz

spikuit-0.2.0/.claude/CLAUDE.md

@@ -0,0 +1,124 @@
+# Spikuit — Development Guide
+
+## Overview
+
+Spikuit (spike + circuit) is a neural knowledge graph with spaced repetition.
+Core engine is LLM-independent. CLI (`spkt`) is the primary interface.
+
+## Repository Structure
+
+```
+spikuit/
+├── spikuit-core/      # Pure engine (FSRS + NetworkX + APPNP + STDP + LIF)
+│   ├── src/spikuit_core/
+│   │   ├── models.py      # Neuron, Synapse, Spike, Plasticity (msgspec)
+│   │   ├── circuit.py     # Public API: fire, retrieve, ensemble, due
+│   │   ├── propagation.py # APPNP spreading + STDP + LIF decay
+│   │   └── db.py          # Async SQLite persistence
+│   └── tests/             # pytest-asyncio tests
+├── spikuit-cli/       # spkt command (Typer)
+│   └── src/spikuit_cli/main.py
+└── spikuit-agents/    # Future: SDK / adapters
+```
+
+## Development Commands
+
+```bash
+# Run all tests
+uv run --package spikuit-core pytest spikuit-core/tests/ -v
+
+# Run CLI
+uv run --package spikuit-cli spkt --help
+
+# Run specific test file
+uv run --package spikuit-core pytest spikuit-core/tests/test_propagation.py -v
+```
+
+## Conventions
+
+- **Models**: msgspec.Struct with type annotations. No dataclasses.
+- **Async**: All DB operations are async (aiosqlite). Circuit methods are async.
+- **TDD**: Write tests first, then implement. Tests use pytest-asyncio.
+- **Naming**: Neuroscience-inspired (Neuron, Synapse, Spike, Circuit, Plasticity).
+- **Language**: Code, comments, docs, skills — all in English.
+- **Responses**: Match the user's language when speaking to them.
+
+## Brain Setup
+
+A Brain is a `.spikuit/` directory — like an Obsidian vault or `.git/`.
+Each Brain has its own graph, config, and review schedule. `spkt` auto-discovers
+`.spikuit/` by walking up from CWD. Use `--brain <path>` to target another Brain.
+
+```bash
+spkt init                              # Interactive wizard
+spkt init -p openai-compat \           # Non-interactive with LM Studio
+  --base-url http://localhost:1234/v1 \
+  --model text-embedding-nomic-embed-text-v1.5
+spkt config                            # Show current brain config
+spkt embed-all                         # Backfill embeddings for existing neurons
+```
+
+Config lives in `.spikuit/config.toml`.
+
+## spkt CLI
+
+All commands support `--json` for machine-readable output and `--brain` to target a specific Brain.
+
+| Command | Purpose |
+|---------|---------|
+| `spkt init` | Initialize .spikuit/ brain |
+| `spkt config` | Show brain configuration |
+| `spkt embed-all` | Backfill embeddings |
+| `spkt add` | Add a Neuron |
+| `spkt fire` | Fire a Spike (FSRS + APPNP + STDP) |
+| `spkt due` | List neurons due for review |
+| `spkt retrieve` | Graph-weighted search |
+| `spkt list` | List neurons (filter by type/domain) |
+| `spkt link` | Create a Synapse |
+| `spkt inspect` | Neuron detail |
+| `spkt stats` | Circuit statistics |
+| `spkt quiz` | Interactive flashcard review session |
+| `spkt visualize` | Interactive graph visualization (HTML) |
+
+## Grade Scale
+
+| Grade | Meaning | FSRS Rating |
+|-------|---------|-------------|
+| `miss` | Failed recall | Again |
+| `weak` | Uncertain | Hard |
+| `fire` | Correct | Good |
+| `strong` | Perfect | Easy |
+
+## Synapse Types
+
+| Type | Direction | Use |
+|------|-----------|-----|
+| `requires` | Directed | A requires understanding B |
+| `extends` | Directed | A extends B |
+| `contrasts` | Bidirectional | A contrasts with B |
+| `relates_to` | Bidirectional | General association |
+
+## Architecture
+
+### Core layer (LLM-free)
+- **Circuit**: Knowledge graph engine (FSRS + NetworkX + propagation + sqlite-vec)
+- **Embedder**: Pluggable text embedding (OpenAICompat, Ollama, Null). Auto-embeds on add/update.
+- **Scaffold**: ZPD-inspired support levels (FULL/GUIDED/MINIMAL/NONE) from FSRS state + graph neighbors
+- **Flashcard**: Self-grade quiz, no LLM required
+
+### Session layer (LLM-powered)
+- **QABotSession**: RAG chat — LLM generates answers from retrieval results (negative feedback, accept, dedup, persistent/ephemeral)
+- **LearnSession**: Knowledge curation — add neurons, discover relations, merge duplicates through dialogue
+- **TutorSession**: 1-on-1 tutoring — scaffolded teaching, hint progression, gap detection, error explanation
+
+### Quiz (evaluation tools used by Sessions)
+- **Flashcard** (core): Self-grade, no LLM
+- **AutoQuiz**: LLM-generated questions, programmatic grading
+- **1 Quiz : N Neurons**: QuizRequest has primary + supporting neurons, QuizResult has per-neuron grades
+
+## Key Algorithms
+
+- **APPNP**: Personalized PageRank propagation. Activation flows along outgoing edges.
+- **STDP**: Edge weights update based on co-fire timing (tau_stdp = 7 days).
+- **LIF**: Pressure accumulates from neighbor fires, decays exponentially (tau_m = 14 days).
+- **FSRS**: Per-neuron spaced repetition. Propagation only affects pressure, never stability/difficulty.

spikuit-0.2.0/.claude/skills/learn/SKILL.md

@@ -0,0 +1,72 @@
+---
+name: learn
+description: "Add new knowledge to the circuit from the current conversation. Use when the user says /learn, 'learn this', 'add this to spikuit', '覚えて', 'ナレッジに追加', '知識追加', or similar."
+---
+
+# Learn — Add Knowledge to Circuit
+
+Extract knowledge from the conversation and add it as Neurons with Synapses.
+
+## Steps
+
+### 1. Identify what to add
+
+From the current conversation, identify discrete pieces of knowledge worth remembering. Each should become one Neuron.
+
+Guidelines:
+- One concept per Neuron (atomic knowledge)
+- Content should be self-contained Markdown
+- Include a `# Title` heading
+- Add explanation, examples, or key points in the body
+- Determine appropriate `type` and `domain`
+
+Common types: `concept`, `theorem`, `definition`, `example`, `procedure`, `vocabulary`
+Common domains: `math`, `cs`, `language`, `philosophy`, `economics`
+
+### 2. Add neurons
+
+For each piece of knowledge:
+
+```bash
+spkt add "<markdown content>" --type <type> --domain <domain> --json
+```
+
+Note: Use `\n` for newlines in the content string.
+
+Save the returned neuron IDs.
+
+### 3. Find related existing neurons
+
+For each new neuron, search for related existing knowledge:
+
+```bash
+spkt retrieve "<relevant keywords>" --json
+```
+
+### 4. Create synapses
+
+If related neurons exist, create appropriate connections:
+
+```bash
+spkt link <new_id> <existing_id> --type <synapse_type> --json
+```
+
+Choose the synapse type based on the relationship:
+- `requires` — New concept requires understanding the existing one
+- `extends` — New concept extends or builds on the existing one
+- `contrasts` — Concepts are in contrast or opposition
+- `relates_to` — General association (default)
+
+### 5. Confirm to user
+
+Show what was added:
+- List of new Neurons (title + ID)
+- Synapses created
+- Suggest running `/review` to reinforce the new knowledge
+
+## Notes
+
+- Always use `--json` for spkt commands
+- If the user provides content in a specific language, keep the Neuron content in that language
+- Don't over-link — only create synapses for meaningful relationships
+- Respond in the user's language

spikuit-0.2.0/.claude/skills/review/SKILL.md

@@ -0,0 +1,77 @@
+---
+name: review
+description: "Run a spaced repetition review session using spkt CLI. Use when the user says /review, 'review', 'study', '復習', '復習しよう', '勉強', or similar."
+---
+
+# Review Session
+
+Run an interactive review session using the spkt CLI.
+
+## Steps
+
+### 1. Get due neurons
+
+```bash
+spkt due --json
+```
+
+If no neurons are due, tell the user and stop.
+
+### 2. For each due neuron, run a review cycle
+
+Loop through the due neurons one at a time:
+
+#### 2a. Read the neuron content
+
+```bash
+spkt inspect <neuron_id> --json
+```
+
+#### 2b. Generate a quiz question
+
+Based on the neuron's content, type, and domain, generate an appropriate quiz question.
+
+Guidelines for quiz generation:
+- **concept**: Ask for a definition, explanation, or example
+- **language**: Ask for translation, conjugation, or fill-in-the-blank
+- **math**: Ask to state a theorem, prove a step, or solve a small problem
+- Adapt difficulty based on FSRS state (Learning = easier, Review = harder)
+- Include the neuron's neighbors for context if relevant
+
+Present the question to the user and wait for their answer.
+
+#### 2c. Grade the answer
+
+Evaluate the user's response and assign a grade:
+- `strong` — Perfect, immediate, confident
+- `fire` — Correct, possibly with minor hesitation
+- `weak` — Partially correct or needed a hint
+- `miss` — Incorrect or couldn't answer
+
+Tell the user the grade and briefly explain if they were wrong.
+
+#### 2d. Record the result
+
+```bash
+spkt fire <neuron_id> --grade <grade> --json
+```
+
+Show the updated FSRS state (next review date).
+
+#### 2e. Ask to continue
+
+After each neuron, ask if the user wants to continue or stop.
+
+### 3. Session summary
+
+When the session ends (no more due neurons or user stops), show:
+- Number of neurons reviewed
+- Grade distribution (how many strong/fire/weak/miss)
+- Next upcoming review date
+
+## Notes
+
+- Always use `--json` when calling spkt for reliable parsing
+- Keep the session conversational — encourage the user
+- If the user asks for a hint, give one but downgrade to `weak` at best
+- Respond in the user's language

spikuit-0.2.0/.github/workflows/docs.yml

@@ -0,0 +1,49 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Set up Python
+        run: uv python install 3.11
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Build docs
+        run: uv run mkdocs build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

spikuit-0.2.0/.gitignore

@@ -0,0 +1,45 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+
+# uv
+uv.lock
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Environment
+.env
+.env.local
+
+# Database
+*.db
+*.sqlite3
+
+# Brain data (project-local)
+.spikuit/
+
+# Coverage
+htmlcov/
+.coverage
+.coverage.*
+spkt-circuit.html
+
+# MkDocs
+site/

spikuit-0.2.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 [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.