dreamloop 0.1.0__py3-none-any.whl

dreamloop-0.1.0.dist-info/METADATA

@@ -0,0 +1,252 @@
+Metadata-Version: 2.4
+Name: dreamloop
+Version: 0.1.0
+Summary: A local-first AI dream journal for people who want to notice patterns in their dreams.
+Project-URL: Homepage, https://github.com/saime428/DreamLoop
+Project-URL: Repository, https://github.com/saime428/DreamLoop
+Project-URL: Issues, https://github.com/saime428/DreamLoop/issues
+Author: DreamLoop contributors
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: fastapi>=0.115
+Requires-Dist: httpx>=0.27
+Requires-Dist: jinja2>=3.1
+Requires-Dist: openai>=1.50
+Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: typer>=0.12
+Requires-Dist: uvicorn>=0.30
+Provides-Extra: ai
+Requires-Dist: chromadb>=0.5; extra == 'ai'
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.3; extra == 'dev'
+Requires-Dist: twine>=5.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# DreamLoop
+
+[English](README.md) | [中文](README.zh-CN.md)
+
+[![CI](https://github.com/saime428/DreamLoop/actions/workflows/ci.yml/badge.svg)](https://github.com/saime428/DreamLoop/actions/workflows/ci.yml)
+
+![DreamLoop dashboard screenshot](docs/assets/dashboard-screenshot.png)
+
+**Your dreams have patterns. DreamLoop finds them locally.**
+
+- Runs fully local. Your data never leaves your machine.
+- Free with Ollama. Optional DeepSeek/OpenAI or custom OpenAI-compatible endpoints.
+- CLI-first, forkable, and built for Obsidian-minded knowledge workers.
+- Detailed dream analysis that favors emotions, real-life context, and multiple verifiable interpretations.
+
+```bash
+git clone https://github.com/saime428/DreamLoop.git
+cd DreamLoop
+uv sync --extra dev
+uv run dreamloop init
+uv run dreamloop web
+```
+
+DreamLoop is a local-first dream journal for people who want fast capture, private storage, and pattern discovery without renting their inner life to another subscription app. The web app follows a six-page loop: Dashboard -> Log -> Detail -> Patterns -> Gallery -> Settings.
+
+## Quick Start
+
+### Run locally without AI
+
+```bash
+git clone https://github.com/saime428/DreamLoop.git
+cd DreamLoop
+uv sync --extra dev
+uv run dreamloop init
+uv run dreamloop add "I found a blue door under the sea."
+uv run dreamloop web
+```
+
+Expected result:
+
+```text
+DreamLoop stores the entry in .dreamloop/dreamloop.sqlite3.
+The local dashboard starts at http://127.0.0.1:8765.
+AI analysis stays pending until you configure a provider.
+```
+
+### Enable local Ollama analysis
+
+```bash
+ollama pull qwen3:8b
+uv run dreamloop ai use ollama --model qwen3:8b
+uv run dreamloop ai test
+uv run dreamloop analyze --pending
+```
+
+Expected result:
+
+```text
+Ollama is used through http://localhost:11434/v1.
+DreamLoop writes structured analysis back to local SQLite.
+```
+
+## Why This Project
+
+Commercial dream apps usually make you pay for analysis and push personal text into a cloud workflow. DreamLoop takes the opposite path: the journal is local, the CLI is the primary interface, and AI is a swappable layer.
+
+The default path is zero-cost Ollama. DeepSeek, OpenAI, and custom OpenAI-compatible endpoints are optional for people who want stronger hosted models or their own local gateway. The code is small enough to fork and direct enough to extend.
+
+## Demo Assets
+
+- Real dashboard screenshot: `docs/assets/dashboard-screenshot.png`
+- Social preview image: `docs/assets/social-preview.png`
+- Reproducible recording guide: `docs/demo-recording.md`
+
+The recording guide covers CLI capture, the Dashboard -> Log -> Detail flow, Patterns filtering, Gallery, and Settings without exposing secrets.
+
+## CLI Demo
+
+```text
+$ uv run dreamloop add "A door opened under the sea."
+saved locally -> .dreamloop/dreamloop.sqlite3
+analysis -> pending
+
+$ uv run dreamloop ai use ollama --model qwen3:8b
+AI provider set to ollama (qwen3:8b).
+
+$ uv run dreamloop analyze --pending
+Analyzed pending dreams when a provider is ready.
+```
+
+## Privacy Promise
+
+- Dream entries are stored in `.dreamloop/dreamloop.sqlite3`.
+- `.dreamloop/` is automatically ignored by Git.
+- Your dreams are never uploaded by default.
+- Ollama keeps analysis local on your machine.
+- DeepSeek/OpenAI only run after explicit configuration.
+- API keys live in `.dreamloop/secrets.env`; secrets do not belong in commits.
+
+## AI Providers
+
+DreamLoop supports provider configuration without changing the journal model:
+
+```bash
+uv run dreamloop ai status
+uv run dreamloop ai use ollama --model qwen3:8b
+uv run dreamloop ai use deepseek --model deepseek-v4-flash
+uv run dreamloop ai use custom --model local-model --base-url http://localhost:1234/v1
+uv run dreamloop ai test
+```
+
+Provider defaults:
+
+- `ollama`: local, `http://localhost:11434/v1`, model `qwen3:8b`
+- `deepseek`: cloud, `https://api.deepseek.com`, model `deepseek-v4-flash`
+- `openai`: cloud, OpenAI-compatible JSON analysis
+- `custom`: any OpenAI-compatible `/v1` endpoint, including local gateways
+- `none`: capture-only local journal mode
+
+## Web App Loop
+
+The FastAPI/Jinja dashboard is intentionally lightweight:
+
+- Dashboard: README-ready overview with AI Insight, heatmap, stats, and recent dreams
+- Log: draft-first dream capture, optional reflection prompts, and AI analysis before saving
+- Detail: original dream text, detailed interpretation, reality-grounded questions, raw JSON, and an opt-in visual-memory entry point
+- Patterns: clickable calendar, recurring symbols, theme trends, and filters back into Log
+- Gallery: v0.1 local visual cards derived from saved dreams; image generation remains opt-in
+- Settings: provider selection, launch notes, local data directory, and privacy status
+
+DreamLoop is currently launched with `uv run dreamloop web` from a checkout or `dreamloop web` after package install. A native desktop app is a later packaging task; v0.1 stays lightweight so the local-first core remains easy to inspect and fork.
+
+The same app exposes JSON endpoints:
+
+- `POST /api/dreams`
+- `GET /api/dreams`
+- `GET /api/dreams/{id}`
+- `GET /api/dreams/{id}/similar`
+- `POST /api/analyze/pending`
+- `POST /api/import/ics`
+- `POST /api/weather/sync`
+- `GET /api/insights/heatmap`
+- `GET /api/insights/trends`
+
+## Local Data Model
+
+```text
+.dreamloop/
+  dreamloop.sqlite3
+  config.json
+  secrets.env
+  chroma/
+  exports/
+  imports/
+```
+
+SQLite stores dreams, analysis results, imported calendar events, and synced weather. ChromaDB remains optional for richer vector search.
+
+## PyPI Release Install
+
+After the v0.1.0 package is published, install it with:
+
+```bash
+pipx install dreamloop
+dreamloop init
+dreamloop add "I was flying above a dark ocean."
+dreamloop web
+```
+
+## Obsidian Roadmap
+
+- v0.2: Markdown export for dream entries and analysis summaries.
+- v0.3: Obsidian vault sync with stable frontmatter.
+- v0.4: Community plugin for capture, backlinks, and local dashboard launch.
+
+## Roadmap
+
+### v0.1
+
+- Local CLI and six-page Web loop.
+- SQLite storage.
+- Ollama-first provider settings.
+- Optional DeepSeek/OpenAI/custom structured analysis.
+- Optional reflection prompts and longer reality-grounded interpretation reports.
+- Heatmap, `.ics` import, weather sync.
+- Similar dreams and basic trends.
+- Real screenshot assets, CI, changelog, and public release packaging.
+
+### v0.2
+
+- Markdown export.
+- CLI GIF/cast release assets.
+- ChromaDB-backed clustering and recurring-theme insights.
+- Backup and restore flows.
+
+### v0.3+
+
+- Obsidian vault sync.
+- Obsidian community plugin.
+- Generated dream illustrations stored locally as opt-in artifacts.
+
+## Contributing
+
+DreamLoop is deliberately small and forkable. Good first contributions:
+
+- improve local model prompts
+- add `.ics` fixtures
+- polish dashboard accessibility
+- expand Markdown/Obsidian export
+- add terminal demo assets
+
+Run tests with:
+
+```bash
+uv run --extra dev pytest
+```
+
+Build the package with:
+
+```bash
+uv build
+```
+
+## License
+
+MIT

dreamloop-0.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+dreamloop/__init__.py,sha256=xA8D-iptXahzk3iEKNImJLRz94cp0NsDj7_8XcCqKs4,66
+dreamloop/analysis.py,sha256=DHZpU-fu3xivsQRGLBq5FE-aZgKvuoVMwiRA0FDbexk,14750
+dreamloop/cli.py,sha256=QwnXd5h16iOXu4sKbdVlf70kfgRk2WNgQVjb147x8bQ,4373
+dreamloop/core.py,sha256=7dv4vR-eO5BDD6DmhvJ924t3k_GxG0vdQJtC9L5khO4,22779
+dreamloop/web.py,sha256=I3ABcYtDy6bGCHeN8Y8_Nr0tnWi7WOB2VcTCmIQ-kbI,33182
+dreamloop/static/style.css,sha256=RitxFaVn220bu3jDCAFK2vvmA0AQwzxPu-G2MVJlyUA,25921
+dreamloop/templates/detail.html,sha256=ZSphlW_tHQAmrx1NAu0PmBop0WE3McB7eSviNJITAvM,7852
+dreamloop/templates/index.html,sha256=DRuB_LDOfNqKeF26mUShFZswI5ttxOq2SoPa-DJP_jo,23947
+dreamloop-0.1.0.dist-info/METADATA,sha256=cO10JPnMP6f1vRlUFASi9fTyMjjwvV0OkkP3rGbfotk,7844
+dreamloop-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+dreamloop-0.1.0.dist-info/entry_points.txt,sha256=yItGYA7sE4_8n-JqxPHLb-2ssPcZwskVXyxXPEJKQ_M,49
+dreamloop-0.1.0.dist-info/licenses/LICENSE,sha256=tdTTe8xBNq3UZ6CIPhjrjPKny6BLMHmelCTiaBZEk1Q,1079
+dreamloop-0.1.0.dist-info/RECORD,,

dreamloop-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

dreamloop-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+dreamloop = dreamloop.cli:main

dreamloop-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 DreamLoop contributors
+
+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.