localdeploy 0.6.0__tar.gz → 0.6.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. {localdeploy-0.6.0 → localdeploy-0.6.2}/CHANGELOG.md +37 -2
  2. {localdeploy-0.6.0 → localdeploy-0.6.2}/LICENSE +1 -1
  3. {localdeploy-0.6.0 → localdeploy-0.6.2}/PKG-INFO +103 -36
  4. {localdeploy-0.6.0 → localdeploy-0.6.2}/README.md +88 -21
  5. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/__init__.py +1 -1
  6. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/benchmark.py +1 -1
  7. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/registry.py +5 -5
  8. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/updates.py +1 -1
  9. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/web/index.html +1 -1
  10. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/web/js/benchmark-views.js +2 -2
  11. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/web/js/benchmark.js +3 -3
  12. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/web/js/models.js +1 -1
  13. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/web/styles.css +6 -6
  14. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy.egg-info/PKG-INFO +103 -36
  15. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy.egg-info/requires.txt +8 -8
  16. {localdeploy-0.6.0 → localdeploy-0.6.2}/pyproject.toml +16 -7
  17. localdeploy-0.6.2/requirements.txt +9 -0
  18. localdeploy-0.6.0/requirements.txt +0 -9
  19. {localdeploy-0.6.0 → localdeploy-0.6.2}/.env.example +0 -0
  20. {localdeploy-0.6.0 → localdeploy-0.6.2}/MANIFEST.in +0 -0
  21. {localdeploy-0.6.0 → localdeploy-0.6.2}/SECURITY.md +0 -0
  22. {localdeploy-0.6.0 → localdeploy-0.6.2}/api_server.py +0 -0
  23. {localdeploy-0.6.0 → localdeploy-0.6.2}/benchmark.py +0 -0
  24. {localdeploy-0.6.0 → localdeploy-0.6.2}/chat_cli.py +0 -0
  25. {localdeploy-0.6.0 → localdeploy-0.6.2}/compare_models.py +0 -0
  26. {localdeploy-0.6.0 → localdeploy-0.6.2}/config.example.json +0 -0
  27. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/backends/__init__.py +0 -0
  28. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/backends/llamacpp.py +0 -0
  29. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/backends/ollama.py +0 -0
  30. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/backends/openai_compatible.py +0 -0
  31. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/chat_cli.py +0 -0
  32. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/cli.py +0 -0
  33. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/compare_models.py +0 -0
  34. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/__init__.py +0 -0
  35. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/_config.py +0 -0
  36. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/_ollama.py +0 -0
  37. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/bakeoff.py +0 -0
  38. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/bench.py +0 -0
  39. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/calibration.py +0 -0
  40. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/community.py +0 -0
  41. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/fit.py +0 -0
  42. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/hardware.py +0 -0
  43. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/history.py +0 -0
  44. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/manifest.py +0 -0
  45. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/models.py +0 -0
  46. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/monitor.py +0 -0
  47. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/profiles.py +0 -0
  48. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/recommend.py +0 -0
  49. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/report.py +0 -0
  50. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/control/starter.py +0 -0
  51. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/grader_sandbox.py +0 -0
  52. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/server.py +0 -0
  53. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/utils.py +0 -0
  54. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/web/favicon.png +0 -0
  55. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/web/js/app.js +0 -0
  56. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/web/js/chat.js +0 -0
  57. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/web/js/shared.js +0 -0
  58. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/web/js/system.js +0 -0
  59. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy/web/logo.svg +0 -0
  60. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy.egg-info/SOURCES.txt +0 -0
  61. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy.egg-info/dependency_links.txt +0 -0
  62. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy.egg-info/entry_points.txt +0 -0
  63. {localdeploy-0.6.0 → localdeploy-0.6.2}/localdeploy.egg-info/top_level.txt +0 -0
  64. {localdeploy-0.6.0 → localdeploy-0.6.2}/setup.cfg +0 -0
@@ -2,6 +2,41 @@
2
2
 
3
3
  All notable changes to this project should be documented here.
4
4
 
5
+ ## 0.6.2 - 2026-10-03
6
+
7
+ - Benchmark screen: the leaderboard and comparison tables said "N/N passed" even for a model with low
8
+ accuracy, because the number counts requests that finished without an error. They now say "completed".
9
+ The `passed` field in saved runs and exports is unchanged.
10
+ - "Contribute anonymized benchmark" is now "Save anonymized benchmark", and its dialog says that the
11
+ snapshot is saved to a file on this computer and nothing is sent anywhere. That was already how it
12
+ worked; the old wording suggested an upload.
13
+ - The category heatmap and the pass/fail matrix used pale text colours made for the dark theme, so the
14
+ category names were nearly invisible in the light theme. They now use the theme's text colour.
15
+ - Launchers: the root launchers (`run.bat`, `run.ps1`, `run.command`, `run.sh`) share one lifecycle,
16
+ report install failures more clearly, and `run.sh` and `run.command` are executable in the repository.
17
+ Install and run documentation was aligned with them.
18
+ - README: opens with the demo and a short quick start, the Docker example uses the `latest` tag, and the
19
+ images use absolute URLs so they render on the PyPI project page.
20
+ - The PyPI summary now matches the repository description.
21
+ - Refreshed the animated product walkthrough.
22
+ - Updated runtime dependencies, including FastAPI 0.141.1, huggingface-hub 1.31.0 and python-dotenv
23
+ 1.2.3, and the GitHub Actions used by CI and the publish workflows. CI now caches pip, and Dependabot
24
+ is configured with grouped updates.
25
+
26
+ ## 0.6.1 - 2026-08-24
27
+
28
+ - Published the Python package to PyPI and added a GHCR container publishing workflow with a
29
+ post-publish health check, build provenance, and an SBOM.
30
+ - GitHub releases now receive the wheel and source archive as downloadable assets.
31
+ - Limited push CI to `main`, added cancellation for superseded runs, and validated every workflow
32
+ with actionlint.
33
+ - Updated project and installer authorship to iodriller and removed a tool-specific repository
34
+ guidance file.
35
+ - Ran the macOS packaging workflow successfully on a GitHub-hosted Apple Silicon runner, including
36
+ building the app, launching it, checking `/health`, and creating the DMG.
37
+ - Renamed the GitHub account from iodriller to oney-erge; updated repository URLs, package and
38
+ installer authorship, and the Windows registry key path to match.
39
+
5
40
  ## 0.6.0 - 2026-07-19
6
41
 
7
42
  ### ModelScope search and direct GGUF import
@@ -59,8 +94,8 @@ All notable changes to this project should be documented here.
59
94
  Menu + Desktop shortcuts, a working Settings > Apps entry, and a fully clean uninstall.
60
95
  - macOS: `packaging/macos.spec` builds a menu-bar-only `.app` (no Dock icon), and
61
96
  `.github/workflows/build-macos.yml` packages it into a `.dmg` with an automated smoke test.
62
- Authored without access to a Mac; the workflow is manual-trigger only until it - or the
63
- resulting `.app` - has actually been run on real hardware.
97
+ The workflow has passed on a GitHub-hosted Apple Silicon runner. The resulting app still needs a
98
+ manual desktop launch before the unsigned DMG should be treated as a normal end-user install.
64
99
  - Neither installer is code-signed yet: Windows SmartScreen and macOS Gatekeeper will both warn on
65
100
  first run. See `docs/PACKAGING.md` for what each warning means and the signing/notarization cost
66
101
  and account requirements to remove them.
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2026 iodriller and LocalDeploy contributors
3
+ Copyright (c) 2026 oney-erge
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
@@ -1,13 +1,13 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: localdeploy
3
- Version: 0.6.0
4
- Summary: A local web UI and OpenAI-compatible API for choosing, running, and benchmarking models with Ollama and other local runtimes.
5
- Author: iodriller and LocalDeploy contributors
3
+ Version: 0.6.2
4
+ Summary: Find, deploy, manage, and benchmark local AI models for your hardware across Ollama, llama.cpp, and compatible runtimes.
5
+ Author: oney-erge
6
6
  License-Expression: MIT
7
- Project-URL: Homepage, https://github.com/iodriller/LocalDeploy
8
- Project-URL: Documentation, https://github.com/iodriller/LocalDeploy#readme
9
- Project-URL: Changelog, https://github.com/iodriller/LocalDeploy/blob/main/CHANGELOG.md
10
- Project-URL: Issues, https://github.com/iodriller/LocalDeploy/issues
7
+ Project-URL: Homepage, https://github.com/oney-erge/LocalDeploy
8
+ Project-URL: Documentation, https://github.com/oney-erge/LocalDeploy#readme
9
+ Project-URL: Changelog, https://github.com/oney-erge/LocalDeploy/blob/main/CHANGELOG.md
10
+ Project-URL: Issues, https://github.com/oney-erge/LocalDeploy/issues
11
11
  Keywords: ollama,llm,local-ai,benchmark,vram,self-hosted
12
12
  Classifier: Development Status :: 4 - Beta
13
13
  Classifier: Environment :: Web Environment
@@ -23,19 +23,19 @@ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
23
23
  Requires-Python: >=3.10
24
24
  Description-Content-Type: text/markdown
25
25
  License-File: LICENSE
26
- Requires-Dist: fastapi==0.136.1
27
- Requires-Dist: uvicorn==0.46.0
28
- Requires-Dist: requests==2.33.1
29
- Requires-Dist: python-dotenv==1.2.2
30
- Requires-Dist: pydantic==2.13.4
31
- Requires-Dist: python-multipart==0.0.31
32
- Requires-Dist: huggingface_hub==1.16.1
26
+ Requires-Dist: fastapi==0.141.1
27
+ Requires-Dist: uvicorn==0.53.0
28
+ Requires-Dist: requests==2.34.2
29
+ Requires-Dist: python-dotenv==1.2.3
30
+ Requires-Dist: pydantic==2.13.5
31
+ Requires-Dist: python-multipart==0.0.32
32
+ Requires-Dist: huggingface_hub==1.31.0
33
33
  Requires-Dist: psutil==7.2.2
34
34
  Requires-Dist: pyyaml==6.0.3
35
35
  Provides-Extra: dev
36
36
  Requires-Dist: pytest>=7.0; extra == "dev"
37
37
  Requires-Dist: httpx>=0.27; extra == "dev"
38
- Requires-Dist: ruff>=0.9; extra == "dev"
38
+ Requires-Dist: ruff==0.16.8; extra == "dev"
39
39
  Requires-Dist: build>=1.2; extra == "dev"
40
40
  Requires-Dist: twine>=5.0; extra == "dev"
41
41
  Requires-Dist: playwright>=1.40; extra == "dev"
@@ -47,30 +47,50 @@ Requires-Dist: pillow>=10.0; extra == "packaging"
47
47
  Dynamic: license-file
48
48
 
49
49
  <p align="center">
50
- <img src="localdeploy/web/logo.svg" width="96" height="96" alt="LocalDeploy logo" />
50
+ <img src="https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/localdeploy/web/logo.svg" width="96" height="96" alt="LocalDeploy logo" />
51
51
  </p>
52
52
 
53
53
  <h1 align="center">LocalDeploy</h1>
54
54
 
55
55
  <p align="center">
56
- A local web UI and API for choosing, running, and comparing AI models on your own hardware.
56
+ <strong>Pick, deploy, and benchmark the best local AI model for your machine.</strong>
57
57
  </p>
58
58
 
59
59
  <p align="center">
60
- <a href="https://github.com/iodriller/LocalDeploy/actions/workflows/ci.yml"><img src="https://github.com/iodriller/LocalDeploy/actions/workflows/ci.yml/badge.svg" alt="CI status" /></a>
60
+ <a href="https://github.com/oney-erge/LocalDeploy/actions/workflows/ci.yml"><img src="https://github.com/oney-erge/LocalDeploy/actions/workflows/ci.yml/badge.svg" alt="CI status" /></a>
61
+ <a href="https://pypi.org/project/localdeploy/"><img src="https://img.shields.io/pypi/v/localdeploy.svg" alt="PyPI version" /></a>
61
62
  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT license" /></a>
62
63
  <img src="https://img.shields.io/badge/python-3.10%2B-blue.svg" alt="Python 3.10+" />
63
64
  <img src="https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux%20%7C%20Docker-555.svg" alt="Platforms" />
64
65
  </p>
65
66
 
66
- I built LocalDeploy because I needed a dependable way to choose and run local models for other work I am involved in. It became useful enough that I decided to make it public. I hope it saves someone else some setup time and trial and error.
67
-
68
- LocalDeploy sits on top of [Ollama](https://ollama.com) and can also work with llama.cpp and loopback OpenAI-compatible runtimes. It detects the machine, estimates whether a model will fit, manages local models, and records benchmark results. LocalDeploy itself does not provide cloud inference.
69
-
70
67
  <p align="center">
71
- <img src="docs/assets/demo.gif" alt="LocalDeploy hardware detection, model selection, chat, and benchmark views" width="820" />
68
+ <img src="https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/docs/assets/demo.gif" alt="LocalDeploy walkthrough showing hardware-aware model recommendations, deployment, local chat, benchmark comparisons, and live monitoring" width="820" />
72
69
  </p>
73
70
 
71
+ LocalDeploy sits on top of [Ollama](https://ollama.com) and can also work with llama.cpp and loopback OpenAI-compatible runtimes. It detects your hardware, estimates whether a model will fit before you download it, manages local models, and records benchmark results. It serves an OpenAI-compatible API, so tools you already use can talk to the model you deployed. It has no telemetry and does not provide cloud inference.
72
+
73
+ ## Quick start
74
+
75
+ With Python 3.10+ and Ollama already installed:
76
+
77
+ ```bash
78
+ pip install localdeploy
79
+ localdeploy # starts the server and opens http://localhost:8000/ui
80
+ ```
81
+
82
+ `uvx localdeploy` runs it without installing, if you use [uv](https://docs.astral.sh/uv/). Add `--no-browser` to keep the browser closed.
83
+
84
+ Without them, use the launcher from a clone. It creates the environment, opens the UI, and on macOS and Linux offers to install a missing Python or Ollama first:
85
+
86
+ ```bash
87
+ git clone https://github.com/oney-erge/LocalDeploy.git
88
+ cd LocalDeploy
89
+ ./run.sh # Linux. macOS: ./run.command Windows: .\run.bat
90
+ ```
91
+
92
+ Docker, the Windows installer, and the details are under [Install](#install).
93
+
74
94
  ## What it does
75
95
 
76
96
  - Detects NVIDIA, AMD, Intel, and Apple Silicon hardware, including compatible multi-GPU layouts.
@@ -85,9 +105,45 @@ LocalDeploy sits on top of [Ollama](https://ollama.com) and can also work with l
85
105
 
86
106
  If you already know which Ollama model you want and only need a terminal chat, Ollama may be all you need. LocalDeploy is meant for the less certain part: choosing a model for a particular machine and comparing it with real runs.
87
107
 
108
+ ## Why it exists
109
+
110
+ I built LocalDeploy because I needed a dependable way to choose and run local models for other work I am involved in. It became useful enough that I decided to make it public. I hope it saves someone else some setup time and trial and error.
111
+
88
112
  ## Install
89
113
 
90
- The PyPI package has not been published yet. Use one of the source installs below. The release process is documented in [docs/RELEASING.md](docs/RELEASING.md).
114
+ The stable project entry points are `run.bat` on Windows, `run.command` on
115
+ macOS, and `run.sh` on Linux. Re-running them is safe. They use the existing
116
+ environment when it is current and repair missing dependencies when needed.
117
+ Each also accepts `doctor`, `repair`, `docker`, `logs`, and `stop`.
118
+
119
+ Setup checks disk space, prevents concurrent environment changes, retries
120
+ temporary network failures up to three times, and writes persistent failures
121
+ to `.setup/install.log`. The `logs` action follows the active native or
122
+ Docker logs rather than requiring Docker.
123
+
124
+ From a clone:
125
+
126
+ ```powershell
127
+ .\run.bat # Windows
128
+ ```
129
+
130
+ ```bash
131
+ ./run.command # macOS
132
+ ./run.sh # Linux
133
+ ```
134
+
135
+ Use `.\run.ps1` from PowerShell. Add an action after any launcher, such as
136
+ `.\run.ps1 doctor` or `./run.sh docker`. The default `run` action waits for
137
+ LocalDeploy to become ready before opening the UI.
138
+
139
+ Install from PyPI when Python and Ollama are already available:
140
+
141
+ ```bash
142
+ python -m pip install localdeploy
143
+ localdeploy
144
+ ```
145
+
146
+ The launchers below can also set up a local clone and help install prerequisites.
91
147
 
92
148
  ### Windows
93
149
 
@@ -95,40 +151,51 @@ The installer can offer to install Python and Ollama through winget, clone the r
95
151
 
96
152
  ```powershell
97
153
  $installer = Join-Path $env:TEMP "localdeploy-install.ps1"
98
- Invoke-RestMethod https://raw.githubusercontent.com/iodriller/LocalDeploy/main/scripts/install.ps1 -OutFile $installer
154
+ Invoke-RestMethod https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/scripts/install.ps1 -OutFile $installer
99
155
  & $installer
100
156
  ```
101
157
 
102
- From an existing clone:
158
+ From an existing clone, use the stable root launcher:
103
159
 
104
160
  ```powershell
105
- git clone https://github.com/iodriller/LocalDeploy.git
161
+ git clone https://github.com/oney-erge/LocalDeploy.git
106
162
  cd LocalDeploy
107
- .\scripts\start.ps1
163
+ .\run.bat
108
164
  ```
109
165
 
110
- The script creates `.env`, `config.json`, and `.venv`, starts Ollama when it is installed, and opens `http://localhost:8000/ui`. Stop it with `.\scripts\stop.ps1`. You can also double-click `start.bat` from a clone or ZIP download.
166
+ The launcher creates `.env`, `config.json`, and `.venv`, starts Ollama when it is installed, and opens `http://localhost:8000/ui`. Stop it with `.\run.ps1 stop`. The lower-level `scripts\start.ps1` remains available for development-specific flags.
111
167
 
112
168
  ### macOS and Linux
113
169
 
114
170
  ```bash
115
- git clone https://github.com/iodriller/LocalDeploy.git
171
+ git clone https://github.com/oney-erge/LocalDeploy.git
116
172
  cd LocalDeploy
117
- ./scripts/start.sh
173
+ ./run.command # macOS
174
+ ./run.sh # Linux
118
175
  ```
119
176
 
120
177
  If Python 3 or Ollama is missing, the launcher offers to install it for you (Homebrew on macOS; apt, dnf, pacman, or zypper for Python and the [official installer](https://ollama.com/download) for Ollama on Linux) and asks before running anything. Answer no, or run non-interactively, and it prints the exact manual command instead.
121
178
 
122
- On macOS you can also double-click `start.command` from a clone (it opens Terminal and runs the launcher). A ZIP download strips the executable bit, so after unzipping run `chmod +x start.command scripts/*.sh` once, or just use `git clone` as above.
179
+ On macOS you can double-click `run.command` from a clone. A ZIP download can strip the executable bit, so after unzipping run `chmod +x run.command run.sh scripts/*.sh` once, or use `git clone` as above.
123
180
 
124
181
  The launcher starts Ollama when it is installed but not already reachable, then keeps the LocalDeploy server in the foreground. Press Ctrl+C to stop LocalDeploy. Run `./scripts/stop.sh --ollama` if you also want to stop an Ollama process started by the launcher. Set `START_OLLAMA=false` in `.env` when another service manages Ollama.
125
182
 
126
183
  ### Docker
127
184
 
128
- Docker builds bundle Ollama, so Python is not needed on the host:
185
+ The published container bundles Ollama, so Python is not needed on the host:
186
+
187
+ ```bash
188
+ docker run -d --name localdeploy \
189
+ -p 127.0.0.1:8000:8000 \
190
+ -v localdeploy-data:/data/localdeploy \
191
+ -v ollama-data:/root/.ollama \
192
+ ghcr.io/oney-erge/localdeploy:latest
193
+ ```
194
+
195
+ To build from source instead:
129
196
 
130
197
  ```bash
131
- git clone https://github.com/iodriller/LocalDeploy.git
198
+ git clone https://github.com/oney-erge/LocalDeploy.git
132
199
  cd LocalDeploy
133
200
  docker compose up --build -d
134
201
  ```
@@ -144,11 +211,11 @@ A new install starts without profiles or models. Pulling the first model creates
144
211
  The hardware and memory estimates are guidance. Drivers, runtime versions, context length, desktop GPU use, and quantization all affect the actual result. LocalDeploy records observed memory after deployment so later estimates can be adjusted for that machine.
145
212
 
146
213
  <p align="center">
147
- <img src="docs/screenshots/setup-deploy.png" alt="Setup and Deploy tab with hardware detection, live VRAM, and model fit information" width="800" />
214
+ <img src="https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/docs/screenshots/setup-deploy.png" alt="Setup and Deploy tab with hardware detection, live VRAM, and model fit information" width="800" />
148
215
  </p>
149
216
 
150
217
  <p align="center">
151
- <img src="docs/screenshots/chat-playground.png" alt="Chat playground with a streamed response from a local model" width="800" />
218
+ <img src="https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/docs/screenshots/chat-playground.png" alt="Chat playground with a streamed response from a local model" width="800" />
152
219
  </p>
153
220
 
154
221
  More screenshots are in [docs/SCREENSHOTS.md](docs/SCREENSHOTS.md).
@@ -1,28 +1,48 @@
1
1
  <p align="center">
2
- <img src="localdeploy/web/logo.svg" width="96" height="96" alt="LocalDeploy logo" />
2
+ <img src="https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/localdeploy/web/logo.svg" width="96" height="96" alt="LocalDeploy logo" />
3
3
  </p>
4
4
 
5
5
  <h1 align="center">LocalDeploy</h1>
6
6
 
7
7
  <p align="center">
8
- A local web UI and API for choosing, running, and comparing AI models on your own hardware.
8
+ <strong>Pick, deploy, and benchmark the best local AI model for your machine.</strong>
9
9
  </p>
10
10
 
11
11
  <p align="center">
12
- <a href="https://github.com/iodriller/LocalDeploy/actions/workflows/ci.yml"><img src="https://github.com/iodriller/LocalDeploy/actions/workflows/ci.yml/badge.svg" alt="CI status" /></a>
12
+ <a href="https://github.com/oney-erge/LocalDeploy/actions/workflows/ci.yml"><img src="https://github.com/oney-erge/LocalDeploy/actions/workflows/ci.yml/badge.svg" alt="CI status" /></a>
13
+ <a href="https://pypi.org/project/localdeploy/"><img src="https://img.shields.io/pypi/v/localdeploy.svg" alt="PyPI version" /></a>
13
14
  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT license" /></a>
14
15
  <img src="https://img.shields.io/badge/python-3.10%2B-blue.svg" alt="Python 3.10+" />
15
16
  <img src="https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux%20%7C%20Docker-555.svg" alt="Platforms" />
16
17
  </p>
17
18
 
18
- I built LocalDeploy because I needed a dependable way to choose and run local models for other work I am involved in. It became useful enough that I decided to make it public. I hope it saves someone else some setup time and trial and error.
19
-
20
- LocalDeploy sits on top of [Ollama](https://ollama.com) and can also work with llama.cpp and loopback OpenAI-compatible runtimes. It detects the machine, estimates whether a model will fit, manages local models, and records benchmark results. LocalDeploy itself does not provide cloud inference.
21
-
22
19
  <p align="center">
23
- <img src="docs/assets/demo.gif" alt="LocalDeploy hardware detection, model selection, chat, and benchmark views" width="820" />
20
+ <img src="https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/docs/assets/demo.gif" alt="LocalDeploy walkthrough showing hardware-aware model recommendations, deployment, local chat, benchmark comparisons, and live monitoring" width="820" />
24
21
  </p>
25
22
 
23
+ LocalDeploy sits on top of [Ollama](https://ollama.com) and can also work with llama.cpp and loopback OpenAI-compatible runtimes. It detects your hardware, estimates whether a model will fit before you download it, manages local models, and records benchmark results. It serves an OpenAI-compatible API, so tools you already use can talk to the model you deployed. It has no telemetry and does not provide cloud inference.
24
+
25
+ ## Quick start
26
+
27
+ With Python 3.10+ and Ollama already installed:
28
+
29
+ ```bash
30
+ pip install localdeploy
31
+ localdeploy # starts the server and opens http://localhost:8000/ui
32
+ ```
33
+
34
+ `uvx localdeploy` runs it without installing, if you use [uv](https://docs.astral.sh/uv/). Add `--no-browser` to keep the browser closed.
35
+
36
+ Without them, use the launcher from a clone. It creates the environment, opens the UI, and on macOS and Linux offers to install a missing Python or Ollama first:
37
+
38
+ ```bash
39
+ git clone https://github.com/oney-erge/LocalDeploy.git
40
+ cd LocalDeploy
41
+ ./run.sh # Linux. macOS: ./run.command Windows: .\run.bat
42
+ ```
43
+
44
+ Docker, the Windows installer, and the details are under [Install](#install).
45
+
26
46
  ## What it does
27
47
 
28
48
  - Detects NVIDIA, AMD, Intel, and Apple Silicon hardware, including compatible multi-GPU layouts.
@@ -37,9 +57,45 @@ LocalDeploy sits on top of [Ollama](https://ollama.com) and can also work with l
37
57
 
38
58
  If you already know which Ollama model you want and only need a terminal chat, Ollama may be all you need. LocalDeploy is meant for the less certain part: choosing a model for a particular machine and comparing it with real runs.
39
59
 
60
+ ## Why it exists
61
+
62
+ I built LocalDeploy because I needed a dependable way to choose and run local models for other work I am involved in. It became useful enough that I decided to make it public. I hope it saves someone else some setup time and trial and error.
63
+
40
64
  ## Install
41
65
 
42
- The PyPI package has not been published yet. Use one of the source installs below. The release process is documented in [docs/RELEASING.md](docs/RELEASING.md).
66
+ The stable project entry points are `run.bat` on Windows, `run.command` on
67
+ macOS, and `run.sh` on Linux. Re-running them is safe. They use the existing
68
+ environment when it is current and repair missing dependencies when needed.
69
+ Each also accepts `doctor`, `repair`, `docker`, `logs`, and `stop`.
70
+
71
+ Setup checks disk space, prevents concurrent environment changes, retries
72
+ temporary network failures up to three times, and writes persistent failures
73
+ to `.setup/install.log`. The `logs` action follows the active native or
74
+ Docker logs rather than requiring Docker.
75
+
76
+ From a clone:
77
+
78
+ ```powershell
79
+ .\run.bat # Windows
80
+ ```
81
+
82
+ ```bash
83
+ ./run.command # macOS
84
+ ./run.sh # Linux
85
+ ```
86
+
87
+ Use `.\run.ps1` from PowerShell. Add an action after any launcher, such as
88
+ `.\run.ps1 doctor` or `./run.sh docker`. The default `run` action waits for
89
+ LocalDeploy to become ready before opening the UI.
90
+
91
+ Install from PyPI when Python and Ollama are already available:
92
+
93
+ ```bash
94
+ python -m pip install localdeploy
95
+ localdeploy
96
+ ```
97
+
98
+ The launchers below can also set up a local clone and help install prerequisites.
43
99
 
44
100
  ### Windows
45
101
 
@@ -47,40 +103,51 @@ The installer can offer to install Python and Ollama through winget, clone the r
47
103
 
48
104
  ```powershell
49
105
  $installer = Join-Path $env:TEMP "localdeploy-install.ps1"
50
- Invoke-RestMethod https://raw.githubusercontent.com/iodriller/LocalDeploy/main/scripts/install.ps1 -OutFile $installer
106
+ Invoke-RestMethod https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/scripts/install.ps1 -OutFile $installer
51
107
  & $installer
52
108
  ```
53
109
 
54
- From an existing clone:
110
+ From an existing clone, use the stable root launcher:
55
111
 
56
112
  ```powershell
57
- git clone https://github.com/iodriller/LocalDeploy.git
113
+ git clone https://github.com/oney-erge/LocalDeploy.git
58
114
  cd LocalDeploy
59
- .\scripts\start.ps1
115
+ .\run.bat
60
116
  ```
61
117
 
62
- The script creates `.env`, `config.json`, and `.venv`, starts Ollama when it is installed, and opens `http://localhost:8000/ui`. Stop it with `.\scripts\stop.ps1`. You can also double-click `start.bat` from a clone or ZIP download.
118
+ The launcher creates `.env`, `config.json`, and `.venv`, starts Ollama when it is installed, and opens `http://localhost:8000/ui`. Stop it with `.\run.ps1 stop`. The lower-level `scripts\start.ps1` remains available for development-specific flags.
63
119
 
64
120
  ### macOS and Linux
65
121
 
66
122
  ```bash
67
- git clone https://github.com/iodriller/LocalDeploy.git
123
+ git clone https://github.com/oney-erge/LocalDeploy.git
68
124
  cd LocalDeploy
69
- ./scripts/start.sh
125
+ ./run.command # macOS
126
+ ./run.sh # Linux
70
127
  ```
71
128
 
72
129
  If Python 3 or Ollama is missing, the launcher offers to install it for you (Homebrew on macOS; apt, dnf, pacman, or zypper for Python and the [official installer](https://ollama.com/download) for Ollama on Linux) and asks before running anything. Answer no, or run non-interactively, and it prints the exact manual command instead.
73
130
 
74
- On macOS you can also double-click `start.command` from a clone (it opens Terminal and runs the launcher). A ZIP download strips the executable bit, so after unzipping run `chmod +x start.command scripts/*.sh` once, or just use `git clone` as above.
131
+ On macOS you can double-click `run.command` from a clone. A ZIP download can strip the executable bit, so after unzipping run `chmod +x run.command run.sh scripts/*.sh` once, or use `git clone` as above.
75
132
 
76
133
  The launcher starts Ollama when it is installed but not already reachable, then keeps the LocalDeploy server in the foreground. Press Ctrl+C to stop LocalDeploy. Run `./scripts/stop.sh --ollama` if you also want to stop an Ollama process started by the launcher. Set `START_OLLAMA=false` in `.env` when another service manages Ollama.
77
134
 
78
135
  ### Docker
79
136
 
80
- Docker builds bundle Ollama, so Python is not needed on the host:
137
+ The published container bundles Ollama, so Python is not needed on the host:
138
+
139
+ ```bash
140
+ docker run -d --name localdeploy \
141
+ -p 127.0.0.1:8000:8000 \
142
+ -v localdeploy-data:/data/localdeploy \
143
+ -v ollama-data:/root/.ollama \
144
+ ghcr.io/oney-erge/localdeploy:latest
145
+ ```
146
+
147
+ To build from source instead:
81
148
 
82
149
  ```bash
83
- git clone https://github.com/iodriller/LocalDeploy.git
150
+ git clone https://github.com/oney-erge/LocalDeploy.git
84
151
  cd LocalDeploy
85
152
  docker compose up --build -d
86
153
  ```
@@ -96,11 +163,11 @@ A new install starts without profiles or models. Pulling the first model creates
96
163
  The hardware and memory estimates are guidance. Drivers, runtime versions, context length, desktop GPU use, and quantization all affect the actual result. LocalDeploy records observed memory after deployment so later estimates can be adjusted for that machine.
97
164
 
98
165
  <p align="center">
99
- <img src="docs/screenshots/setup-deploy.png" alt="Setup and Deploy tab with hardware detection, live VRAM, and model fit information" width="800" />
166
+ <img src="https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/docs/screenshots/setup-deploy.png" alt="Setup and Deploy tab with hardware detection, live VRAM, and model fit information" width="800" />
100
167
  </p>
101
168
 
102
169
  <p align="center">
103
- <img src="docs/screenshots/chat-playground.png" alt="Chat playground with a streamed response from a local model" width="800" />
170
+ <img src="https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/docs/screenshots/chat-playground.png" alt="Chat playground with a streamed response from a local model" width="800" />
104
171
  </p>
105
172
 
106
173
  More screenshots are in [docs/SCREENSHOTS.md](docs/SCREENSHOTS.md).
@@ -1,3 +1,3 @@
1
1
  """LocalDeploy manages and benchmarks AI models on local runtimes."""
2
2
 
3
- __version__ = "0.6.0"
3
+ __version__ = "0.6.2"
@@ -1020,7 +1020,7 @@ TEST_CASES: List[TestCase] = [
1020
1020
  prompt=(
1021
1021
  "Extract a task list from this user message:\n"
1022
1022
  "\"Hey can you do these: Watch my Downloads folder for new PDFs and send a summary of each one to me. "
1023
- "Also schedule a daily 9am report on yesterday's commits in my github.com/iodriller/LocalDeploy repo. "
1023
+ "Also schedule a daily 9am report on yesterday's commits in my github.com/oney-erge/LocalDeploy repo. "
1024
1024
  "Don't bother me about Codex or anything advanced.\"\n\n"
1025
1025
  "Schema:\n"
1026
1026
  "{\n"
@@ -290,7 +290,7 @@ def search_ollama_library(req: LibrarySearchRequest) -> Dict[str, Any]:
290
290
  resp = requests.get(
291
291
  "https://ollama.com/search",
292
292
  params={"q": req.query.strip()},
293
- headers={"User-Agent": "LocalDeploy (+https://github.com/iodriller/LocalDeploy)"},
293
+ headers={"User-Agent": "LocalDeploy (+https://github.com/oney-erge/LocalDeploy)"},
294
294
  timeout=15,
295
295
  )
296
296
  resp.raise_for_status()
@@ -363,7 +363,7 @@ def library_tags(req: LibraryTagsRequest) -> Dict[str, Any]:
363
363
  try:
364
364
  resp = requests.get(
365
365
  f"https://ollama.com/library/{family}/tags",
366
- headers={"User-Agent": "LocalDeploy (+https://github.com/iodriller/LocalDeploy)"},
366
+ headers={"User-Agent": "LocalDeploy (+https://github.com/oney-erge/LocalDeploy)"},
367
367
  timeout=15,
368
368
  )
369
369
  resp.raise_for_status()
@@ -402,7 +402,7 @@ def _library_rows(query: str, limit: int) -> Tuple[List[Dict[str, Any]], Optiona
402
402
  resp = requests.get(
403
403
  "https://ollama.com/search",
404
404
  params={"q": query},
405
- headers={"User-Agent": "LocalDeploy (+https://github.com/iodriller/LocalDeploy)"},
405
+ headers={"User-Agent": "LocalDeploy (+https://github.com/oney-erge/LocalDeploy)"},
406
406
  timeout=15,
407
407
  )
408
408
  resp.raise_for_status()
@@ -518,7 +518,7 @@ def _modelscope_list_gguf_files(repo_id: str) -> Tuple[List[Dict[str, Any]], Opt
518
518
  resp = requests.get(
519
519
  _MODELSCOPE_FILES_URL.format(repo_id=repo_id),
520
520
  params={"Revision": "master", "Recursive": "True"},
521
- headers={"User-Agent": "LocalDeploy (+https://github.com/iodriller/LocalDeploy)"},
521
+ headers={"User-Agent": "LocalDeploy (+https://github.com/oney-erge/LocalDeploy)"},
522
522
  timeout=10,
523
523
  )
524
524
  except requests.RequestException as exc:
@@ -625,7 +625,7 @@ def _modelscope_rows(query: str, limit: int) -> Tuple[List[Dict[str, Any]], Opti
625
625
  resp = requests.get(
626
626
  _MODELSCOPE_SEARCH_URL,
627
627
  params={"search": search_text, "sort": "downloads", "page_number": 1, "page_size": max(1, limit)},
628
- headers={"User-Agent": "LocalDeploy (+https://github.com/iodriller/LocalDeploy)"},
628
+ headers={"User-Agent": "LocalDeploy (+https://github.com/oney-erge/LocalDeploy)"},
629
629
  timeout=15,
630
630
  )
631
631
  resp.raise_for_status()
@@ -23,7 +23,7 @@ from ..utils import offline_mode
23
23
 
24
24
  router = APIRouter()
25
25
 
26
- _REPO = "iodriller/LocalDeploy"
26
+ _REPO = "oney-erge/LocalDeploy"
27
27
  _RELEASES_API = f"https://api.github.com/repos/{_REPO}/releases"
28
28
  _REQUEST_TIMEOUT = 6
29
29
 
@@ -646,7 +646,7 @@
646
646
  <div class="row gap">
647
647
  <button class="btn danger" id="btn-run-cancel" hidden>Cancel</button>
648
648
  <button class="btn" id="btn-export" disabled title="Select a completed run">Export run</button>
649
- <button class="btn" id="btn-contribute" disabled title="Select a completed run">Contribute anonymized benchmark</button>
649
+ <button class="btn" id="btn-contribute" disabled title="Select a completed run">Save anonymized benchmark</button>
650
650
  </div>
651
651
  </div>
652
652
  <div class="bench-summary-grid">
@@ -18,7 +18,7 @@ export function renderWinners(runs) {
18
18
  const bestTps = [...runs].filter((run) => run.summary.avg_tokens_per_second != null).sort((a, b) => b.summary.avg_tokens_per_second - a.summary.avg_tokens_per_second)[0];
19
19
  const categories = new Set(runs.flatMap((run) => (run.category_summary || categorySummary(run.tests)).map((row) => row.category)));
20
20
  return [
21
- `<div class="metric-tile"><span>Top run</span><strong>${esc(runLabel(top))}</strong><small>${esc(top.summary.passed)}/${esc(top.summary.tests)} passed</small></div>`,
21
+ `<div class="metric-tile"><span>Top run</span><strong>${esc(runLabel(top))}</strong><small>${esc(top.summary.passed)}/${esc(top.summary.tests)} completed</small></div>`,
22
22
  `<div class="metric-tile"><span>Accuracy</span><strong>${esc(top.summary.avg_accuracy)}</strong><small>${esc(top.questionSetName || "benchmark")}</small></div>`,
23
23
  fastest ? `<div class="metric-tile"><span>Fastest</span><strong>${esc(fastest.summary.avg_latency_s)}s</strong><small>${esc(runLabel(fastest))}</small></div>` : "",
24
24
  bestTps ? `<div class="metric-tile"><span>Best tok/s</span><strong>${esc(bestTps.summary.avg_tokens_per_second)}</strong><small>${esc(runLabel(bestTps))}</small></div>` : "",
@@ -28,7 +28,7 @@ export function renderWinners(runs) {
28
28
 
29
29
  export function renderLeaderboard(runs) {
30
30
  if (!runs.length) return "Benchmark results appear here after the first streamed test result.";
31
- const rows = [...runs].sort((a, b) => (b.summary.passed || 0) - (a.summary.passed || 0) || (b.summary.avg_accuracy || 0) - (a.summary.avg_accuracy || 0) || (a.summary.avg_latency_s || 999999) - (b.summary.avg_latency_s || 999999)).map((run, index) => `<div class="leaderboard-row"><span class="rank">${index + 1}</span><div class="leaderboard-name"><b>${esc(runLabel(run))}</b><span>${esc(run.questionSetName || "")}</span></div><div class="leaderboard-metrics"><span><b>${esc(run.summary.passed)}/${esc(run.summary.tests)}</b> passed</span><span><b>${esc(run.summary.avg_accuracy)}</b> acc</span><span><b>${esc(run.summary.avg_latency_s)}s</b> latency</span><span><b>${esc(run.summary.avg_tokens_per_second ?? "-")}</b> tok/s</span></div></div>`).join("");
31
+ const rows = [...runs].sort((a, b) => (b.summary.passed || 0) - (a.summary.passed || 0) || (b.summary.avg_accuracy || 0) - (a.summary.avg_accuracy || 0) || (a.summary.avg_latency_s || 999999) - (b.summary.avg_latency_s || 999999)).map((run, index) => `<div class="leaderboard-row"><span class="rank">${index + 1}</span><div class="leaderboard-name"><b>${esc(runLabel(run))}</b><span>${esc(run.questionSetName || "")}</span></div><div class="leaderboard-metrics"><span><b>${esc(run.summary.passed)}/${esc(run.summary.tests)}</b> completed</span><span><b>${esc(run.summary.avg_accuracy)}</b> acc</span><span><b>${esc(run.summary.avg_latency_s)}s</b> latency</span><span><b>${esc(run.summary.avg_tokens_per_second ?? "-")}</b> tok/s</span></div></div>`).join("");
32
32
  return `<div class="leaderboard-list">${rows}</div>`;
33
33
  }
34
34
 
@@ -1213,7 +1213,7 @@ async function renderComparison(runs, baseline) {
1213
1213
  .map((name) => `<button class="btn compact response-compare-btn" data-test="${esc(name)}">${esc(name)}</button>`)
1214
1214
  .join("");
1215
1215
  $("#compare-body").innerHTML = `<div class="table-wrap"><table class="results">
1216
- <thead><tr><th>Run</th><th class="num">Passed</th><th class="num">Accuracy Δ</th><th class="num">Latency Δ</th><th class="num">tok/s Δ</th></tr></thead>
1216
+ <thead><tr><th>Run</th><th class="num">Completed</th><th class="num">Accuracy Δ</th><th class="num">Latency Δ</th><th class="num">tok/s Δ</th></tr></thead>
1217
1217
  <tbody>${rows}</tbody></table></div>
1218
1218
  <h3 class="sub">Response detail</h3><div class="response-test-list">${testButtons}</div>
1219
1219
  <div id="regression-diffs"></div>`;
@@ -1329,8 +1329,8 @@ async function contributeRun() {
1329
1329
  const out = await postJSON("/system/community/preview", { card: runToCardPayload(run) });
1330
1330
  if (!out.success) throw new Error(out.error || "Preview failed.");
1331
1331
  const overlay = simpleModal(
1332
- "Contribute this benchmark",
1333
- `Exactly what would be shared - review before saving. ${esc(out.note)}`,
1332
+ "Save an anonymized benchmark",
1333
+ `This anonymized snapshot is saved to a file on this computer. Nothing is sent anywhere. ${esc(out.note)}`,
1334
1334
  `<pre class="log manifest-yaml">${esc(JSON.stringify(out.would_share, null, 2))}</pre>
1335
1335
  <details style="margin-top:0.5rem"><summary class="muted small">Never included</summary>
1336
1336
  <div class="muted small">${out.excluded_fields.map(esc).join(", ")}</div>
@@ -1375,7 +1375,7 @@ function renderBakeoffResult(evt) {
1375
1375
  <h3 class="sub">${esc(evt.winner)}</h3>
1376
1376
  </div>
1377
1377
  <div class="table-wrap"><table class="results">
1378
- <thead><tr><th>Model</th><th class="num">Passed</th><th class="num">Accuracy</th><th class="num">Avg latency</th><th class="num">Headroom</th></tr></thead>
1378
+ <thead><tr><th>Model</th><th class="num">Completed</th><th class="num">Accuracy</th><th class="num">Avg latency</th><th class="num">Headroom</th></tr></thead>
1379
1379
  <tbody>${rows}</tbody>
1380
1380
  </table></div>
1381
1381
  <div class="row gap wrap" style="margin-top:0.5rem">
@@ -1454,7 +1454,7 @@ table.results td.num, table.results th.num { text-align: right; font-variant-num
1454
1454
  font-weight: 700;
1455
1455
  }
1456
1456
  .heat-category {
1457
- color: #d8dde6;
1457
+ color: var(--text);
1458
1458
  font-weight: 650;
1459
1459
  }
1460
1460
  .heat-cell {
@@ -1462,9 +1462,9 @@ table.results td.num, table.results th.num { text-align: right; font-variant-num
1462
1462
  font-variant-numeric: tabular-nums;
1463
1463
  font-weight: 700;
1464
1464
  }
1465
- .heat-good { background: rgba(34, 133, 83, 0.48); color: #d9fce6; }
1466
- .heat-warn { background: rgba(151, 122, 35, 0.42); color: #fbefb6; }
1467
- .heat-bad { background: rgba(143, 55, 55, 0.38); color: #ffd9d9; }
1465
+ .heat-good { background: rgba(34, 133, 83, 0.48); color: var(--text); }
1466
+ .heat-warn { background: rgba(151, 122, 35, 0.42); color: var(--text); }
1467
+ .heat-bad { background: rgba(143, 55, 55, 0.38); color: var(--text); }
1468
1468
  .matrix-wrap {
1469
1469
  max-height: 320px;
1470
1470
  overflow: auto;
@@ -1494,8 +1494,8 @@ table.results td.num, table.results th.num { text-align: right; font-variant-num
1494
1494
  font-weight: 750;
1495
1495
  font-variant-numeric: tabular-nums;
1496
1496
  }
1497
- .matrix-pass { color: #d9fce6; background: rgba(34, 133, 83, 0.32); }
1498
- .matrix-fail { color: #ffd9d9; background: rgba(143, 55, 55, 0.3); }
1497
+ .matrix-pass { color: var(--text); background: rgba(34, 133, 83, 0.32); }
1498
+ .matrix-fail { color: var(--text); background: rgba(143, 55, 55, 0.3); }
1499
1499
  .matrix-note { margin-top: 0.45rem; }
1500
1500
  .run-library {
1501
1501
  display: grid;
@@ -1,13 +1,13 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: localdeploy
3
- Version: 0.6.0
4
- Summary: A local web UI and OpenAI-compatible API for choosing, running, and benchmarking models with Ollama and other local runtimes.
5
- Author: iodriller and LocalDeploy contributors
3
+ Version: 0.6.2
4
+ Summary: Find, deploy, manage, and benchmark local AI models for your hardware across Ollama, llama.cpp, and compatible runtimes.
5
+ Author: oney-erge
6
6
  License-Expression: MIT
7
- Project-URL: Homepage, https://github.com/iodriller/LocalDeploy
8
- Project-URL: Documentation, https://github.com/iodriller/LocalDeploy#readme
9
- Project-URL: Changelog, https://github.com/iodriller/LocalDeploy/blob/main/CHANGELOG.md
10
- Project-URL: Issues, https://github.com/iodriller/LocalDeploy/issues
7
+ Project-URL: Homepage, https://github.com/oney-erge/LocalDeploy
8
+ Project-URL: Documentation, https://github.com/oney-erge/LocalDeploy#readme
9
+ Project-URL: Changelog, https://github.com/oney-erge/LocalDeploy/blob/main/CHANGELOG.md
10
+ Project-URL: Issues, https://github.com/oney-erge/LocalDeploy/issues
11
11
  Keywords: ollama,llm,local-ai,benchmark,vram,self-hosted
12
12
  Classifier: Development Status :: 4 - Beta
13
13
  Classifier: Environment :: Web Environment
@@ -23,19 +23,19 @@ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
23
23
  Requires-Python: >=3.10
24
24
  Description-Content-Type: text/markdown
25
25
  License-File: LICENSE
26
- Requires-Dist: fastapi==0.136.1
27
- Requires-Dist: uvicorn==0.46.0
28
- Requires-Dist: requests==2.33.1
29
- Requires-Dist: python-dotenv==1.2.2
30
- Requires-Dist: pydantic==2.13.4
31
- Requires-Dist: python-multipart==0.0.31
32
- Requires-Dist: huggingface_hub==1.16.1
26
+ Requires-Dist: fastapi==0.141.1
27
+ Requires-Dist: uvicorn==0.53.0
28
+ Requires-Dist: requests==2.34.2
29
+ Requires-Dist: python-dotenv==1.2.3
30
+ Requires-Dist: pydantic==2.13.5
31
+ Requires-Dist: python-multipart==0.0.32
32
+ Requires-Dist: huggingface_hub==1.31.0
33
33
  Requires-Dist: psutil==7.2.2
34
34
  Requires-Dist: pyyaml==6.0.3
35
35
  Provides-Extra: dev
36
36
  Requires-Dist: pytest>=7.0; extra == "dev"
37
37
  Requires-Dist: httpx>=0.27; extra == "dev"
38
- Requires-Dist: ruff>=0.9; extra == "dev"
38
+ Requires-Dist: ruff==0.16.8; extra == "dev"
39
39
  Requires-Dist: build>=1.2; extra == "dev"
40
40
  Requires-Dist: twine>=5.0; extra == "dev"
41
41
  Requires-Dist: playwright>=1.40; extra == "dev"
@@ -47,30 +47,50 @@ Requires-Dist: pillow>=10.0; extra == "packaging"
47
47
  Dynamic: license-file
48
48
 
49
49
  <p align="center">
50
- <img src="localdeploy/web/logo.svg" width="96" height="96" alt="LocalDeploy logo" />
50
+ <img src="https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/localdeploy/web/logo.svg" width="96" height="96" alt="LocalDeploy logo" />
51
51
  </p>
52
52
 
53
53
  <h1 align="center">LocalDeploy</h1>
54
54
 
55
55
  <p align="center">
56
- A local web UI and API for choosing, running, and comparing AI models on your own hardware.
56
+ <strong>Pick, deploy, and benchmark the best local AI model for your machine.</strong>
57
57
  </p>
58
58
 
59
59
  <p align="center">
60
- <a href="https://github.com/iodriller/LocalDeploy/actions/workflows/ci.yml"><img src="https://github.com/iodriller/LocalDeploy/actions/workflows/ci.yml/badge.svg" alt="CI status" /></a>
60
+ <a href="https://github.com/oney-erge/LocalDeploy/actions/workflows/ci.yml"><img src="https://github.com/oney-erge/LocalDeploy/actions/workflows/ci.yml/badge.svg" alt="CI status" /></a>
61
+ <a href="https://pypi.org/project/localdeploy/"><img src="https://img.shields.io/pypi/v/localdeploy.svg" alt="PyPI version" /></a>
61
62
  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT license" /></a>
62
63
  <img src="https://img.shields.io/badge/python-3.10%2B-blue.svg" alt="Python 3.10+" />
63
64
  <img src="https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux%20%7C%20Docker-555.svg" alt="Platforms" />
64
65
  </p>
65
66
 
66
- I built LocalDeploy because I needed a dependable way to choose and run local models for other work I am involved in. It became useful enough that I decided to make it public. I hope it saves someone else some setup time and trial and error.
67
-
68
- LocalDeploy sits on top of [Ollama](https://ollama.com) and can also work with llama.cpp and loopback OpenAI-compatible runtimes. It detects the machine, estimates whether a model will fit, manages local models, and records benchmark results. LocalDeploy itself does not provide cloud inference.
69
-
70
67
  <p align="center">
71
- <img src="docs/assets/demo.gif" alt="LocalDeploy hardware detection, model selection, chat, and benchmark views" width="820" />
68
+ <img src="https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/docs/assets/demo.gif" alt="LocalDeploy walkthrough showing hardware-aware model recommendations, deployment, local chat, benchmark comparisons, and live monitoring" width="820" />
72
69
  </p>
73
70
 
71
+ LocalDeploy sits on top of [Ollama](https://ollama.com) and can also work with llama.cpp and loopback OpenAI-compatible runtimes. It detects your hardware, estimates whether a model will fit before you download it, manages local models, and records benchmark results. It serves an OpenAI-compatible API, so tools you already use can talk to the model you deployed. It has no telemetry and does not provide cloud inference.
72
+
73
+ ## Quick start
74
+
75
+ With Python 3.10+ and Ollama already installed:
76
+
77
+ ```bash
78
+ pip install localdeploy
79
+ localdeploy # starts the server and opens http://localhost:8000/ui
80
+ ```
81
+
82
+ `uvx localdeploy` runs it without installing, if you use [uv](https://docs.astral.sh/uv/). Add `--no-browser` to keep the browser closed.
83
+
84
+ Without them, use the launcher from a clone. It creates the environment, opens the UI, and on macOS and Linux offers to install a missing Python or Ollama first:
85
+
86
+ ```bash
87
+ git clone https://github.com/oney-erge/LocalDeploy.git
88
+ cd LocalDeploy
89
+ ./run.sh # Linux. macOS: ./run.command Windows: .\run.bat
90
+ ```
91
+
92
+ Docker, the Windows installer, and the details are under [Install](#install).
93
+
74
94
  ## What it does
75
95
 
76
96
  - Detects NVIDIA, AMD, Intel, and Apple Silicon hardware, including compatible multi-GPU layouts.
@@ -85,9 +105,45 @@ LocalDeploy sits on top of [Ollama](https://ollama.com) and can also work with l
85
105
 
86
106
  If you already know which Ollama model you want and only need a terminal chat, Ollama may be all you need. LocalDeploy is meant for the less certain part: choosing a model for a particular machine and comparing it with real runs.
87
107
 
108
+ ## Why it exists
109
+
110
+ I built LocalDeploy because I needed a dependable way to choose and run local models for other work I am involved in. It became useful enough that I decided to make it public. I hope it saves someone else some setup time and trial and error.
111
+
88
112
  ## Install
89
113
 
90
- The PyPI package has not been published yet. Use one of the source installs below. The release process is documented in [docs/RELEASING.md](docs/RELEASING.md).
114
+ The stable project entry points are `run.bat` on Windows, `run.command` on
115
+ macOS, and `run.sh` on Linux. Re-running them is safe. They use the existing
116
+ environment when it is current and repair missing dependencies when needed.
117
+ Each also accepts `doctor`, `repair`, `docker`, `logs`, and `stop`.
118
+
119
+ Setup checks disk space, prevents concurrent environment changes, retries
120
+ temporary network failures up to three times, and writes persistent failures
121
+ to `.setup/install.log`. The `logs` action follows the active native or
122
+ Docker logs rather than requiring Docker.
123
+
124
+ From a clone:
125
+
126
+ ```powershell
127
+ .\run.bat # Windows
128
+ ```
129
+
130
+ ```bash
131
+ ./run.command # macOS
132
+ ./run.sh # Linux
133
+ ```
134
+
135
+ Use `.\run.ps1` from PowerShell. Add an action after any launcher, such as
136
+ `.\run.ps1 doctor` or `./run.sh docker`. The default `run` action waits for
137
+ LocalDeploy to become ready before opening the UI.
138
+
139
+ Install from PyPI when Python and Ollama are already available:
140
+
141
+ ```bash
142
+ python -m pip install localdeploy
143
+ localdeploy
144
+ ```
145
+
146
+ The launchers below can also set up a local clone and help install prerequisites.
91
147
 
92
148
  ### Windows
93
149
 
@@ -95,40 +151,51 @@ The installer can offer to install Python and Ollama through winget, clone the r
95
151
 
96
152
  ```powershell
97
153
  $installer = Join-Path $env:TEMP "localdeploy-install.ps1"
98
- Invoke-RestMethod https://raw.githubusercontent.com/iodriller/LocalDeploy/main/scripts/install.ps1 -OutFile $installer
154
+ Invoke-RestMethod https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/scripts/install.ps1 -OutFile $installer
99
155
  & $installer
100
156
  ```
101
157
 
102
- From an existing clone:
158
+ From an existing clone, use the stable root launcher:
103
159
 
104
160
  ```powershell
105
- git clone https://github.com/iodriller/LocalDeploy.git
161
+ git clone https://github.com/oney-erge/LocalDeploy.git
106
162
  cd LocalDeploy
107
- .\scripts\start.ps1
163
+ .\run.bat
108
164
  ```
109
165
 
110
- The script creates `.env`, `config.json`, and `.venv`, starts Ollama when it is installed, and opens `http://localhost:8000/ui`. Stop it with `.\scripts\stop.ps1`. You can also double-click `start.bat` from a clone or ZIP download.
166
+ The launcher creates `.env`, `config.json`, and `.venv`, starts Ollama when it is installed, and opens `http://localhost:8000/ui`. Stop it with `.\run.ps1 stop`. The lower-level `scripts\start.ps1` remains available for development-specific flags.
111
167
 
112
168
  ### macOS and Linux
113
169
 
114
170
  ```bash
115
- git clone https://github.com/iodriller/LocalDeploy.git
171
+ git clone https://github.com/oney-erge/LocalDeploy.git
116
172
  cd LocalDeploy
117
- ./scripts/start.sh
173
+ ./run.command # macOS
174
+ ./run.sh # Linux
118
175
  ```
119
176
 
120
177
  If Python 3 or Ollama is missing, the launcher offers to install it for you (Homebrew on macOS; apt, dnf, pacman, or zypper for Python and the [official installer](https://ollama.com/download) for Ollama on Linux) and asks before running anything. Answer no, or run non-interactively, and it prints the exact manual command instead.
121
178
 
122
- On macOS you can also double-click `start.command` from a clone (it opens Terminal and runs the launcher). A ZIP download strips the executable bit, so after unzipping run `chmod +x start.command scripts/*.sh` once, or just use `git clone` as above.
179
+ On macOS you can double-click `run.command` from a clone. A ZIP download can strip the executable bit, so after unzipping run `chmod +x run.command run.sh scripts/*.sh` once, or use `git clone` as above.
123
180
 
124
181
  The launcher starts Ollama when it is installed but not already reachable, then keeps the LocalDeploy server in the foreground. Press Ctrl+C to stop LocalDeploy. Run `./scripts/stop.sh --ollama` if you also want to stop an Ollama process started by the launcher. Set `START_OLLAMA=false` in `.env` when another service manages Ollama.
125
182
 
126
183
  ### Docker
127
184
 
128
- Docker builds bundle Ollama, so Python is not needed on the host:
185
+ The published container bundles Ollama, so Python is not needed on the host:
186
+
187
+ ```bash
188
+ docker run -d --name localdeploy \
189
+ -p 127.0.0.1:8000:8000 \
190
+ -v localdeploy-data:/data/localdeploy \
191
+ -v ollama-data:/root/.ollama \
192
+ ghcr.io/oney-erge/localdeploy:latest
193
+ ```
194
+
195
+ To build from source instead:
129
196
 
130
197
  ```bash
131
- git clone https://github.com/iodriller/LocalDeploy.git
198
+ git clone https://github.com/oney-erge/LocalDeploy.git
132
199
  cd LocalDeploy
133
200
  docker compose up --build -d
134
201
  ```
@@ -144,11 +211,11 @@ A new install starts without profiles or models. Pulling the first model creates
144
211
  The hardware and memory estimates are guidance. Drivers, runtime versions, context length, desktop GPU use, and quantization all affect the actual result. LocalDeploy records observed memory after deployment so later estimates can be adjusted for that machine.
145
212
 
146
213
  <p align="center">
147
- <img src="docs/screenshots/setup-deploy.png" alt="Setup and Deploy tab with hardware detection, live VRAM, and model fit information" width="800" />
214
+ <img src="https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/docs/screenshots/setup-deploy.png" alt="Setup and Deploy tab with hardware detection, live VRAM, and model fit information" width="800" />
148
215
  </p>
149
216
 
150
217
  <p align="center">
151
- <img src="docs/screenshots/chat-playground.png" alt="Chat playground with a streamed response from a local model" width="800" />
218
+ <img src="https://raw.githubusercontent.com/oney-erge/LocalDeploy/main/docs/screenshots/chat-playground.png" alt="Chat playground with a streamed response from a local model" width="800" />
152
219
  </p>
153
220
 
154
221
  More screenshots are in [docs/SCREENSHOTS.md](docs/SCREENSHOTS.md).
@@ -1,17 +1,17 @@
1
- fastapi==0.136.1
2
- uvicorn==0.46.0
3
- requests==2.33.1
4
- python-dotenv==1.2.2
5
- pydantic==2.13.4
6
- python-multipart==0.0.31
7
- huggingface_hub==1.16.1
1
+ fastapi==0.141.1
2
+ uvicorn==0.53.0
3
+ requests==2.34.2
4
+ python-dotenv==1.2.3
5
+ pydantic==2.13.5
6
+ python-multipart==0.0.32
7
+ huggingface_hub==1.31.0
8
8
  psutil==7.2.2
9
9
  pyyaml==6.0.3
10
10
 
11
11
  [dev]
12
12
  pytest>=7.0
13
13
  httpx>=0.27
14
- ruff>=0.9
14
+ ruff==0.16.8
15
15
  build>=1.2
16
16
  twine>=5.0
17
17
  playwright>=1.40
@@ -5,12 +5,12 @@ build-backend = "setuptools.build_meta"
5
5
  [project]
6
6
  name = "localdeploy"
7
7
  dynamic = ["version", "dependencies"]
8
- description = "A local web UI and OpenAI-compatible API for choosing, running, and benchmarking models with Ollama and other local runtimes."
8
+ description = "Find, deploy, manage, and benchmark local AI models for your hardware across Ollama, llama.cpp, and compatible runtimes."
9
9
  readme = "README.md"
10
10
  license = "MIT"
11
11
  license-files = ["LICENSE"]
12
12
  requires-python = ">=3.10"
13
- authors = [{ name = "iodriller and LocalDeploy contributors" }]
13
+ authors = [{ name = "oney-erge" }]
14
14
  keywords = ["ollama", "llm", "local-ai", "benchmark", "vram", "self-hosted"]
15
15
  classifiers = [
16
16
  "Development Status :: 4 - Beta",
@@ -29,7 +29,7 @@ classifiers = [
29
29
  dev = [
30
30
  "pytest>=7.0",
31
31
  "httpx>=0.27",
32
- "ruff>=0.9",
32
+ "ruff==0.16.8",
33
33
  "build>=1.2",
34
34
  "twine>=5.0",
35
35
  "playwright>=1.40",
@@ -47,10 +47,10 @@ packaging = [
47
47
  localdeploy = "localdeploy.cli:main"
48
48
 
49
49
  [project.urls]
50
- Homepage = "https://github.com/iodriller/LocalDeploy"
51
- Documentation = "https://github.com/iodriller/LocalDeploy#readme"
52
- Changelog = "https://github.com/iodriller/LocalDeploy/blob/main/CHANGELOG.md"
53
- Issues = "https://github.com/iodriller/LocalDeploy/issues"
50
+ Homepage = "https://github.com/oney-erge/LocalDeploy"
51
+ Documentation = "https://github.com/oney-erge/LocalDeploy#readme"
52
+ Changelog = "https://github.com/oney-erge/LocalDeploy/blob/main/CHANGELOG.md"
53
+ Issues = "https://github.com/oney-erge/LocalDeploy/issues"
54
54
 
55
55
  [tool.setuptools]
56
56
  # The four root modules ship alongside the package: api_server is the ASGI app
@@ -70,3 +70,12 @@ localdeploy = ["web/*", "web/js/*.js"]
70
70
  [tool.pytest.ini_options]
71
71
  testpaths = ["tests"]
72
72
  python_files = ["test_*.py"]
73
+
74
+ [tool.ruff]
75
+ target-version = "py310"
76
+
77
+ [tool.ruff.lint]
78
+ # Keep CI's established baseline explicit. Ruff 0.16 broadened its implicit
79
+ # defaults, which made a dependency-only update surface unrelated preview and
80
+ # style families across the entire repository.
81
+ select = ["E4", "E7", "E9", "F"]
@@ -0,0 +1,9 @@
1
+ fastapi==0.141.1
2
+ uvicorn==0.53.0
3
+ requests==2.34.2
4
+ python-dotenv==1.2.3
5
+ pydantic==2.13.5
6
+ python-multipart==0.0.32
7
+ huggingface_hub==1.31.0
8
+ psutil==7.2.2
9
+ pyyaml==6.0.3
@@ -1,9 +0,0 @@
1
- fastapi==0.136.1
2
- uvicorn==0.46.0
3
- requests==2.33.1
4
- python-dotenv==1.2.2
5
- pydantic==2.13.4
6
- python-multipart==0.0.31
7
- huggingface_hub==1.16.1
8
- psutil==7.2.2
9
- pyyaml==6.0.3
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes