omarchy-dms 0.1.0__tar.gz

omarchy_dms-0.1.0/LICENSE

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

omarchy_dms-0.1.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: omarchy-dms
+Version: 0.1.0
+Summary: Omarchy themes as Dank Material Shell (dmsProfiles) looks
+Author: Mikel Villota
+License-Expression: MIT
+Project-URL: Repository, https://github.com/Villoh/omarchy-dms
+Project-URL: Issues, https://github.com/Villoh/omarchy-dms/issues
+Keywords: omarchy,dms,dankmaterialshell,theme,dmsprofiles
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Desktop Environment
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# omarchy-dms
+
+Use [Omarchy](https://omarchy.org) themes in [Dank Material Shell](https://danklinux.com)
+as [dmsProfiles](https://github.com/satoshoe-dev/dms-profiles) looks: colors, wallpapers
+and light/dark mode, switchable from the profile picker.
+
+It converts an Omarchy `colors.toml` into a DMS custom theme (with the Browse previews),
+copies the theme's wallpapers, and creates one profile per theme through `dms ipc`.
+Themes from the [omarchy.org/themes](https://omarchy.org/themes/) store install with one command.
+
+## Requirements
+
+DMS with the `dmsProfiles` plugin enabled, Python 3.11+, `git`, and optionally `fzf`
+(pickers). No other dependencies.
+
+## Install
+
+```sh
+pipx install omarchy-dms
+# or, from the repository
+pipx install git+https://github.com/Villoh/omarchy-dms
+```
+
+On Nix: `nix run github:Villoh/omarchy-dms`.
+
+## Usage
+
+```sh
+omarchy-dms install                      # pick from the omarchy.org/themes store (fzf)
+omarchy-dms install owner/repo           # or a repo / git URL
+omarchy-dms installed                    # every theme, its origin, and whether it has a profile
+omarchy-dms update [theme...]            # refetch installed themes (all, or the ones named)
+omarchy-dms remove [-y] [theme...]       # theme, wallpapers and profile (no names: fzf, Tab marks)
+omarchy-dms list                         # repos listed on the store
+omarchy-dms sync [--force] [theme...]    # profiles for Omarchy's own themes (see below)
+```
+
+Themes land in `~/.config/DankMaterialShell/themes/omarchy-<name>/` and wallpapers in
+`~/Pictures/Wallpapers/omarchy/<name>/`. Only themes with a `colors.toml` work; alacritty-only
+themes are rejected.
+
+**Own themes.** `sync` needs Omarchy's own `themes/` directory, given by `OMARCHY_THEMES`
+(for example a checkout of `basecamp/omarchy`), with the theme folders already in place
+for DMS: `omarchy-dms render <colors.toml> <name> <outdir>` writes one.
+
+**Wallpaper carousel.** dmsProfiles stores one wallpaper copy per profile. The CLI registers
+itself as the profile *apply command* so that, after a switch, the wallpaper points back at the
+theme's folder and a carousel lists all of its images.
+
+## As a library
+
+`omarchy_dms.Omarchy(dms, store, ...)` is the API behind the CLI: it never prints or exits,
+progress goes to a `log` callback and failures are exceptions (`DmsError`, `StoreError`,
+`ThemeError`). Another frontend can import it instead of running the CLI.
+
+```python
+from omarchy_dms import Dms, Omarchy, Store
+
+omarchy = Omarchy(Dms(), Store(themes_dir, wallpapers_dir), log=print)
+omarchy.install("owner/omarchy-example-theme")
+```
+
+## Development
+
+```sh
+uv sync
+uv run python -m unittest discover -s tests
+uv run ruff check . && uv run ruff format --check .
+```
+
+## Releasing
+
+Bump `version` in `pyproject.toml` (the Nix package reads it from there), commit, then tag it:
+
+```sh
+git tag v0.1.0 && git push origin v0.1.0
+```
+
+`.github/workflows/release.yml` does the rest: it checks the tag against the version, runs CI,
+builds and smoke-tests the package, publishes it to PyPI with trusted publishing, and creates the
+GitHub release. Its notes are `.github/release-notes/<tag>.md` if you wrote one, otherwise
+the ones GitHub generates from merged pull requests.
+
+## License
+
+[MIT](LICENSE)

omarchy_dms-0.1.0/README.md

@@ -0,0 +1,86 @@
+# omarchy-dms
+
+Use [Omarchy](https://omarchy.org) themes in [Dank Material Shell](https://danklinux.com)
+as [dmsProfiles](https://github.com/satoshoe-dev/dms-profiles) looks: colors, wallpapers
+and light/dark mode, switchable from the profile picker.
+
+It converts an Omarchy `colors.toml` into a DMS custom theme (with the Browse previews),
+copies the theme's wallpapers, and creates one profile per theme through `dms ipc`.
+Themes from the [omarchy.org/themes](https://omarchy.org/themes/) store install with one command.
+
+## Requirements
+
+DMS with the `dmsProfiles` plugin enabled, Python 3.11+, `git`, and optionally `fzf`
+(pickers). No other dependencies.
+
+## Install
+
+```sh
+pipx install omarchy-dms
+# or, from the repository
+pipx install git+https://github.com/Villoh/omarchy-dms
+```
+
+On Nix: `nix run github:Villoh/omarchy-dms`.
+
+## Usage
+
+```sh
+omarchy-dms install                      # pick from the omarchy.org/themes store (fzf)
+omarchy-dms install owner/repo           # or a repo / git URL
+omarchy-dms installed                    # every theme, its origin, and whether it has a profile
+omarchy-dms update [theme...]            # refetch installed themes (all, or the ones named)
+omarchy-dms remove [-y] [theme...]       # theme, wallpapers and profile (no names: fzf, Tab marks)
+omarchy-dms list                         # repos listed on the store
+omarchy-dms sync [--force] [theme...]    # profiles for Omarchy's own themes (see below)
+```
+
+Themes land in `~/.config/DankMaterialShell/themes/omarchy-<name>/` and wallpapers in
+`~/Pictures/Wallpapers/omarchy/<name>/`. Only themes with a `colors.toml` work; alacritty-only
+themes are rejected.
+
+**Own themes.** `sync` needs Omarchy's own `themes/` directory, given by `OMARCHY_THEMES`
+(for example a checkout of `basecamp/omarchy`), with the theme folders already in place
+for DMS: `omarchy-dms render <colors.toml> <name> <outdir>` writes one.
+
+**Wallpaper carousel.** dmsProfiles stores one wallpaper copy per profile. The CLI registers
+itself as the profile *apply command* so that, after a switch, the wallpaper points back at the
+theme's folder and a carousel lists all of its images.
+
+## As a library
+
+`omarchy_dms.Omarchy(dms, store, ...)` is the API behind the CLI: it never prints or exits,
+progress goes to a `log` callback and failures are exceptions (`DmsError`, `StoreError`,
+`ThemeError`). Another frontend can import it instead of running the CLI.
+
+```python
+from omarchy_dms import Dms, Omarchy, Store
+
+omarchy = Omarchy(Dms(), Store(themes_dir, wallpapers_dir), log=print)
+omarchy.install("owner/omarchy-example-theme")
+```
+
+## Development
+
+```sh
+uv sync
+uv run python -m unittest discover -s tests
+uv run ruff check . && uv run ruff format --check .
+```
+
+## Releasing
+
+Bump `version` in `pyproject.toml` (the Nix package reads it from there), commit, then tag it:
+
+```sh
+git tag v0.1.0 && git push origin v0.1.0
+```
+
+`.github/workflows/release.yml` does the rest: it checks the tag against the version, runs CI,
+builds and smoke-tests the package, publishes it to PyPI with trusted publishing, and creates the
+GitHub release. Its notes are `.github/release-notes/<tag>.md` if you wrote one, otherwise
+the ones GitHub generates from merged pull requests.
+
+## License
+
+[MIT](LICENSE)

omarchy_dms-0.1.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "omarchy-dms"
+version = "0.1.0"
+description = "Omarchy themes as Dank Material Shell (dmsProfiles) looks"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+authors = [{ name = "Mikel Villota" }]
+keywords = ["omarchy", "dms", "dankmaterialshell", "theme", "dmsprofiles"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Operating System :: POSIX :: Linux",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Topic :: Desktop Environment",
+]
+
+[project.urls]
+Repository = "https://github.com/Villoh/omarchy-dms"
+Issues = "https://github.com/Villoh/omarchy-dms/issues"
+
+[project.scripts]
+omarchy-dms = "omarchy_dms.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pyright]
+extraPaths = ["src"]
+
+[dependency-groups]
+dev = ["ruff>=0.11.0"]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 120
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+
+# The preview SVG template and long test literals read better unwrapped.
+[tool.ruff.lint.per-file-ignores]
+"src/omarchy_dms/theme.py" = ["E501"]
+"tests/*.py" = ["E501"]

omarchy_dms-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

omarchy_dms-0.1.0/src/omarchy_dms/__init__.py

@@ -0,0 +1,24 @@
+"""Omarchy themes as DMS profiles.
+
+Library first: `ops.Omarchy` is the API (no printing, no exiting, progress goes
+to a `log` callback); `cli` is one thin frontend over it. Other frontends import
+this package instead of shelling out to the CLI.
+"""
+
+from .dms import Dms, DmsError
+from .ops import Omarchy, Row, store_repos
+from .store import Store, StoreError, Theme, resolve_repo
+from .theme import ThemeError
+
+__all__ = [
+    "Dms",
+    "DmsError",
+    "Omarchy",
+    "Row",
+    "Store",
+    "StoreError",
+    "Theme",
+    "ThemeError",
+    "resolve_repo",
+    "store_repos",
+]

omarchy_dms-0.1.0/src/omarchy_dms/__main__.py

@@ -0,0 +1,5 @@
+import sys
+
+from .cli import main
+
+sys.exit(main())

omarchy_dms-0.1.0/src/omarchy_dms/cli.py

@@ -0,0 +1,92 @@
+"""Command line frontend over ops.Omarchy."""
+
+import argparse
+import os
+import shlex
+import shutil
+import subprocess
+import sys
+from pathlib import Path
+
+from . import theme
+from .dms import Dms, DmsError
+from .ops import Omarchy, store_repos
+from .store import Store, StoreError
+
+HOME = Path.home()
+THEMES = HOME / ".config/DankMaterialShell/themes"
+WALLPAPERS = HOME / "Pictures/Wallpapers/omarchy"
+
+
+def _hook_command():
+    exe = shutil.which("omarchy-dms")
+    return f"{shlex.quote(exe)} hook" if exe else f"{shlex.quote(sys.executable)} -m omarchy_dms hook"
+
+
+def _pick(items, prompt, multi):
+    if not shutil.which("fzf"):
+        raise StoreError("fzf not found: pass the name(s) as arguments")
+    cmd = ["fzf", "--prompt", prompt, *(["-m"] if multi else [])]
+    r = subprocess.run(cmd, input="\n".join(items), text=True, stdout=subprocess.PIPE, check=False)
+    return r.stdout.split()
+
+
+def _parser():
+    p = argparse.ArgumentParser(prog="omarchy-dms", description="Omarchy themes as DMS profiles.")
+    sub = p.add_subparsers(dest="cmd", required=True)
+    s = sub.add_parser("sync", help="create profiles for Omarchy's own themes (all, or the ones named)")
+    s.add_argument("--force", action="store_true", help="recreate the ones that exist")
+    s.add_argument("themes", nargs="*")
+    s = sub.add_parser("install", help="install a community theme and create its profile")
+    s.add_argument("repo", nargs="?", help="owner/repo or git URL (none: pick from omarchy.org/themes)")
+    s = sub.add_parser("update", help="refresh themes installed with install (all, or the ones named)")
+    s.add_argument("themes", nargs="*")
+    s = sub.add_parser("remove", help="remove theme, wallpapers and profile (none named: pick with fzf)")
+    s.add_argument("-y", "--yes", action="store_true", help="do not ask")
+    s.add_argument("themes", nargs="*")
+    sub.add_parser("installed", help="every theme, where it comes from, profile or not")
+    sub.add_parser("list", help="repos listed on omarchy.org/themes")
+    s = sub.add_parser("render", help="convert a colors.toml into a DMS theme folder")
+    s.add_argument("colors")
+    s.add_argument("slug")
+    s.add_argument("outdir")
+    sub.add_parser("hook", help="dmsProfiles apply command (reads DMS_PROFILE_SLUG)")
+    return p
+
+
+def main(argv=None):
+    args = _parser().parse_args(argv)
+    builtin = Path(os.environ["OMARCHY_THEMES"]) if "OMARCHY_THEMES" in os.environ else None
+    omarchy = Omarchy(Dms(), Store(THEMES, WALLPAPERS), builtin, _hook_command())
+    try:
+        match args.cmd:
+            case "sync":
+                omarchy.sync(args.themes, args.force)
+            case "install":
+                repo = args.repo or next(iter(_pick(store_repos(), "omarchy theme> ", False)), None)
+                if repo:
+                    omarchy.install(repo)
+            case "update":
+                return 1 if omarchy.update(args.themes) else 0
+            case "remove":
+                names = args.themes or _pick(omarchy.store.slugs(), "remove (Tab marks)> ", True)
+                if names and not args.yes:
+                    print(f"remove: {' '.join(names)}")
+                    if input("continue? [y/N] ") != "y":
+                        return 0
+                if names:
+                    omarchy.remove(names)
+            case "installed":
+                for row in omarchy.installed():
+                    origin = row.origin or "community (no .source: reinstall to track)"
+                    print(f"{row.slug:<22} {'profile' if row.profile else '-':<8} {origin}")
+            case "list":
+                print("\n".join(store_repos()))
+            case "render":
+                theme.render(args.colors, args.slug, args.outdir)
+            case "hook":
+                omarchy.hook(os.environ.get("DMS_PROFILE_SLUG", ""))
+    except (DmsError, StoreError, theme.ThemeError) as e:
+        print(f"error: {e}", file=sys.stderr)
+        return 1
+    return 0

omarchy_dms-0.1.0/src/omarchy_dms/dms.py

@@ -0,0 +1,132 @@
+"""Thin client for the DMS shell over `dms ipc`.
+
+`runner` is the only thing that touches the process table, so a frontend or a
+test can swap it. Calls the plugin finishes asynchronously (create, remove,
+apply) are polled until the shell reports the result, instead of sleeping.
+"""
+
+import contextlib
+import json
+import subprocess
+import time
+from collections.abc import Callable
+
+Runner = Callable[[list[str]], str]
+
+
+class DmsError(RuntimeError):
+    pass
+
+
+def run_dms(args):
+    try:
+        p = subprocess.run(["dms", *args], capture_output=True, text=True, check=False)
+    except FileNotFoundError as e:
+        raise DmsError("dms not found in PATH") from e
+    if p.returncode:
+        raise DmsError(f"dms {' '.join(args)}: {p.stderr.strip() or p.stdout.strip()}")
+    return p.stdout.strip()
+
+
+class Dms:
+    def __init__(
+        self,
+        runner: Runner = run_dms,
+        sleep=time.sleep,
+        attempts=60,
+        interval=0.25,
+        spawn: Callable[..., object] = subprocess.Popen,
+    ):
+        self._run = runner
+        self._sleep = sleep
+        self.attempts = attempts
+        self.interval = interval
+        self._spawn = spawn
+
+    def ipc(self, *args):
+        return self._run(["ipc", "call", *args])
+
+    def _json(self, *args):
+        out = self.ipc(*args)
+        try:
+            return json.loads(out or "null")
+        except json.JSONDecodeError as e:
+            raise DmsError(f"dms ipc call {' '.join(args)}: not JSON: {out[:80]!r}") from e
+
+    def _wait(self, what, ok):
+        for _ in range(self.attempts):
+            if ok():
+                return
+            self._sleep(self.interval)
+        raise DmsError(f"timed out waiting for {what}")
+
+    # -- reading
+    def profiles(self):
+        return self._json("profiles", "list") or []
+
+    def find_profile(self, slug, name):
+        return next((p for p in self.profiles() if p.get("slug") == slug or p.get("name") == name), None)
+
+    def status(self):
+        return self._json("profiles", "status") or {}
+
+    def active(self):
+        return self.status().get("active", "")
+
+    def snapshot(self):
+        return self._json("profiles", "snapshot") or {}
+
+    # -- profiles
+    def set_option(self, key, value):
+        self.ipc("profiles", "setOption", key, value)
+
+    @contextlib.contextmanager
+    def autosave_paused(self):
+        """Autosave would write each theme change into the previously active profile."""
+        self.set_option("autosave", "false")
+        try:
+            yield
+        finally:
+            self.set_option("autosave", "true")
+
+    def create_profile(self, name):
+        self.ipc("profiles", "create", name)
+        self._wait(f"profile {name!r}", lambda: any(p.get("name") == name for p in self.profiles()))
+
+    def remove_profile(self, slug):
+        self.ipc("profiles", "remove", slug)
+        self._wait(f"profile {slug!r} to go", lambda: all(p.get("slug") != slug for p in self.profiles()))
+
+    def apply_profile(self, slug):
+        self.ipc("profiles", "apply", slug)
+
+        def done():
+            s = self.status()
+            return s.get("active") == slug and not s.get("switching")
+
+        self._wait(f"profile {slug!r} to apply", done)
+
+    # -- the look itself
+    def custom_theme(self, theme_json, theme_id):
+        self.ipc("profiles", "customTheme", str(theme_json), theme_id, "default", "default", "default", "both")
+        self._wait("theme", lambda: self.snapshot().get("settings", {}).get("customThemeFile") == str(theme_json))
+
+    def set_mode(self, mode):
+        self.ipc("theme", mode)
+        self._wait(f"{mode} mode", lambda: self.snapshot().get("session", {}).get("isLightMode") == (mode == "light"))
+
+    def set_wallpaper(self, path):
+        out = self.ipc("wallpaper", "set", str(path))
+        if out.startswith("ERROR"):
+            raise DmsError(out)
+        self._wait("wallpaper", lambda: self.snapshot().get("session", {}).get("wallpaperPath") == str(path))
+
+    def set_wallpaper_later(self, path, delay=2):
+        """Detached, so the caller (dmsProfiles' apply command) returns at once."""
+        self._spawn(
+            ["sh", "-c", 'sleep "$1"; exec dms ipc call wallpaper set "$2"', "_", str(delay), str(path)],
+            start_new_session=True,
+            stdin=subprocess.DEVNULL,
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.DEVNULL,
+        )