opendesk-local 0.1.0__tar.gz

opendesk_local-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug report
+description: Report something broken in OpenDesk
+labels: [bug]
+body:
+  - type: textarea
+    id: what
+    attributes:
+      label: What happened?
+      description: What you ran, what you expected, what you saw.
+      placeholder: |
+        Command: opendesk scan demo_ws --db demo.db
+        Expected: files indexed: 2
+        Saw: error: ...
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: Output of `opendesk --version` (or `python -m opendesk --version`).
+      placeholder: opendesk 0.1.0
+    validations:
+      required: true
+  - type: textarea
+    id: env
+    attributes:
+      label: Environment
+      description: OS, Python version, how you installed (pipx / pip / docker).
+      placeholder: Windows 11, Python 3.12, pipx install .
+    validations:
+      required: false
+  - type: checkboxes
+    id: privacy
+    attributes:
+      label: Privacy
+      options:
+        - label: I did not paste private file contents, secrets, or API keys.
+          required: true
+---

opendesk_local-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,32 @@
+---
+name: Feature request
+description: Suggest something for local-first OpenDesk
+labels: [enhancement]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem
+      description: What local workflow is painful today?
+      placeholder: I want to find duplicate notes across folders without uploading them.
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposal
+      description: Smallest change that would help. CLI sketch welcome.
+      placeholder: opendesk report --format json already shows X; add Y...
+    validations:
+      required: true
+  - type: checkboxes
+    id: scope
+    attributes:
+      label: Scope check
+      description: Must stay true for OpenDesk contributions.
+      options:
+        - label: Works fully offline with no account, no telemetry, no paid hosting.
+          required: true
+        - label: Never auto-deletes user files.
+          required: true
+---

opendesk_local-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+# Continuous integration: full pytest suite, no servers, no network.
+#
+# Matrix covers the platforms strangers install from. Tests are headless
+# and non-blocking by design: no uvicorn is started (FastAPI is exercised
+# in-process via TestClient), no browser is launched, nothing reads the
+# network. The suite must pass on a clean checkout with:
+#   pip install -e ".[test]" && python -m pytest -q
+
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: pip install -e ".[test]"
+      - name: Test
+        run: python -m pytest -q

opendesk_local-0.1.0/.github/workflows/publish-ghcr.yml

@@ -0,0 +1,45 @@
+# Publish the Docker image to GHCR on version tags. Free, no extra auth.
+#
+# Authenticates with GITHUB_TOKEN only (no personal tokens, no secrets).
+# Pushes ghcr.io/shubhanand18091111-bruno/opendesk:<tag> and :latest using the existing
+# Dockerfile unchanged.
+#
+# Trigger: git tag vX.Y.Z && git push origin vX.Y.Z
+
+name: Publish to GHCR
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  image:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: docker/setup-buildx-action@v3
+      - name: Log in to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Image tags
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ghcr.io/${{ github.repository }}
+          tags: |
+            type=ref,event=tag
+            type=raw,value=latest
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

opendesk_local-0.1.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,32 @@
+# Publish to PyPI on version tags. No stored secrets.
+#
+# Uses OIDC trusted publishing (pypa/gh-action-pypi-publish): GitHub mints
+# a short-lived token via `id-token: write`, so no API token is ever saved
+# in repo secrets. Before the first publish, register this repo + workflow
+# as a trusted publisher on PyPI (see RELEASE_CHECKLIST.md).
+#
+# Trigger: git tag vX.Y.Z && git push origin vX.Y.Z
+
+name: Publish to PyPI
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build wheel and sdist
+        run: |
+          pip install build
+          python -m build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

opendesk_local-0.1.0/.gitignore

@@ -0,0 +1,26 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+venv/
+build/
+dist/
+
+# pytest / coverage
+.pytest_cache/
+.coverage
+htmlcov/
+
+# SQLite index (local-only artifacts)
+*.db
+*.db-journal
+*.sqlite
+*.sqlite-journal
+.opendesk/
+
+# OS / editors
+.DS_Store
+Thumbs.db
+.vscode/
+.idea/

opendesk_local-0.1.0/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+All notable changes to OpenDesk. Format follows Keep-a-Changelog basics;
+versions are `vX.Y.Z` tags. Unreleased changes accumulate at the top.
+
+## [0.1.0] — first public release candidate
+
+Local-first workspace observatory: point it at a folder, search and
+question your own files privately. No cloud, no account, no telemetry.
+
+### Added
+
+- `scan`: recursive folder indexing into local SQLite FTS5 (supported text
+  types; skips `.git`/`node_modules`/`__pycache__`/`.venv`, files over
+  50 MB, secret-looking files stored metadata-only).
+- `search`: fully offline keyword search with snippets, BM25 scores, source
+  paths, `--type`/`--limit` filters, LIKE fallback with warning if FTS5 is
+  unavailable.
+- `report`: workspace health (duplicates by hash, empty/large/stale files,
+  possible secrets redacted, failed extractions, repeated names,
+  README-less folders) in text/Markdown/JSON; snapshots saved for export.
+- `ask`: optional AI Q&A — local retrieval first, then only top retrieved
+  chunks to a user-configured Ollama/OpenAI-compatible/custom endpoint;
+  citations on every answer, "Not enough evidence." when weak.
+- `export`: evidence bundles (answers + reports) to Markdown/JSON, secrets
+  redacted, API keys never stored.
+- `serve`: localhost-only web UI (search, report, settings) on
+  `127.0.0.1:8484`, zero CDN/analytics.
+- Distribution: pipx/pip install (`opendesk-local` on PyPI, command stays
+  `opendesk`), Dockerfile + GHCR image, GitHub Actions CI
+  (ubuntu/windows/macos × Python 3.12), trusted-publisher PyPI releases.
+
+### Measured performance (Windows desktop, Python 3.14, SSD)
+
+- Indexing: ~750 chunks/sec (502 files / 25,123 chunks / 21 MB in ~34 s,
+  one-time; re-scans are incremental by hash).
+- Search at 25,000 chunks: cold ~7 ms, warm ~2 ms, common-term top-10
+  ~43 ms — under the 200 ms target. Ranking is BM25 best-first.
+
+### Honest limitations
+
+Keyword search only (no embeddings); single machine, no sync; text-based
+types; does not replace cloud backup, team suites, permission systems, or
+professional advice.

opendesk_local-0.1.0/CHARTER.md

@@ -0,0 +1,68 @@
+# OpenDesk Charter
+
+Version: 0.1.0 (skeleton phase)
+License: Apache-2.0
+Status: draft MVP skeleton
+
+## 1. What OpenDesk is
+
+OpenDesk is a zero-budget open-source project. A local-first workspace observatory that helps users search, map, clean, and question their own local files privately, without uploading data to a cloud service.
+
+## 2. Mission
+
+Build a product so useful that users can replace paid cloud document-search and file-Q&A workflows for personal/local use.
+
+## 3. Core principles (non-negotiable)
+
+1. Local-first: user data stays on the user's machine.
+2. No account required.
+3. No telemetry.
+4. No cloud dependency.
+5. No paid infrastructure.
+6. Core features must work without AI.
+7. AI features must be optional and cite sources.
+8. Never delete user files automatically.
+9. Prefer boring, reliable technology.
+10. Every feature must have tests.
+
+## 4. Target MVP
+
+A Python CLI + local web UI that can:
+
+- [ ] Scan a user-selected folder
+- [ ] Index supported text-based files
+- [ ] Search locally using SQLite FTS5
+- [ ] Show file snippets and source paths
+- [ ] Generate a workspace health report
+- [ ] Optionally answer questions using a local/user-provided AI endpoint
+- [ ] Export evidence reports to Markdown and JSON
+
+Stack: Python 3.12, SQLite, SQLite FTS5, FastAPI, Typer or Click for CLI, local HTML/CSS/JS UI served from localhost, pytest for tests.
+
+## 5. Explicit non-goals
+
+Will not build: Cloud SaaS, login/auth, billing, team sync, marketplace, plugin system, mobile app, analytics/telemetry, website, external CDN dependencies, features that require paid hosting.
+
+## 6. Reliability rules
+
+- Boring tech over clever tech.
+- SQLite is the source of truth for the index.
+- Read-only by default: never delete user files automatically.
+- Every feature ships with pytest coverage.
+- CLI is scriptable: stable exit codes, machine-readable JSON output where applicable.
+- Web UI is localhost-only, no external assets.
+
+## 7. AI policy
+
+- Core search/clean/map works with zero AI.
+- AI Q&A is optional, user-configured local endpoint only.
+- AI answers must cite local source paths + snippets.
+- No data leaves the machine unless the user explicitly configures an endpoint.
+
+## 8. Current phase
+
+Repository structure, project charter, dependencies, and basic CLI skeleton.
+
+Deliverable: `opendesk --help` works. `pyproject.toml`, `README.md`, `LICENSE`, `src/opendesk/`, `tests/` exist. Tests pass.
+
+Next phases (not this skeleton): scanner, indexer (FTS5), search, health report, serve UI, evidence export, optional AI.

opendesk_local-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing to OpenDesk
+
+Zero-budget, local-first, boring technology. Small focused PRs welcome.
+
+## Principles (from CHARTER.md)
+
+1. Local-first: user data stays on the machine.
+2. No account, no telemetry, no cloud, no paid infra.
+3. Core features work without AI; AI is optional and cites sources.
+4. Never delete user files automatically.
+5. Every feature must have tests.
+
+## Setup
+
+```powershell
+python -m venv .venv
+.venv\Scripts\Activate.ps1
+pip install -e ".[test]"
+python -m pytest -q
+```
+
+## Workflow
+
+1. Pick a small issue (or file one with the bug/feature template).
+2. Add/adjust code under `src/opendesk/` — keep dependencies minimal (stdlib
+   preferred; justify anything new).
+3. Add tests under `tests/` (use `tmp_path`, never touch real user data;
+   never add network calls to tests).
+4. Run `python -m pytest -q` — all tests must pass.
+5. Update docs if behavior changed (`README.md`, `CHARTER.md` if scope).
+6. Open a PR describing: what, why, how tested.
+
+## Boundaries (will be declined)
+
+- Cloud SaaS, login/auth, billing, team sync, marketplace, plugins, mobile
+  app, analytics/telemetry, website, CDN dependencies, paid hosting.
+- Features that auto-delete user files or exfiltrate data.
+- New required dependencies for core search/report (AI extras must stay optional).
+
+## Style
+
+- Python 3.12+, line length 100 (see `pyproject.toml` ruff config).
+- CLI output must stay scriptable (stable labels, exit codes).
+- No emojis in code/CLI output unless the user asks.

opendesk_local-0.1.0/Dockerfile

@@ -0,0 +1,17 @@
+# Local-only container for OpenDesk. No hosted infrastructure.
+FROM python:3.12-slim
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1
+
+WORKDIR /app
+
+COPY pyproject.toml README.md LICENSE ./
+COPY src/ src/
+RUN pip install --no-cache-dir .
+
+# Local UI port (bind localhost when running).
+EXPOSE 8484
+
+ENTRYPOINT ["opendesk"]
+CMD ["--help"]

opendesk_local-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 OpenDesk 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.