hueman-cli 0.2.1__tar.gz → 0.3.1__tar.gz

{hueman_cli-0.2.1 → hueman_cli-0.3.1}/CONTRIBUTING.md

@@ -22,7 +22,7 @@ Run `python -m pytest -q` before opening the PR.
 
 ## Documentation
 
-The docs live in `website/content/latest` (written in Spanish).
+The docs live in `website/content/latest` (English, public product language).
 
 - Add a tool or target: [add-a-tool](website/content/latest/guides/add-a-tool.md)
 - Add a palette: [add-a-palette](website/content/latest/guides/add-a-palette.md)
@@ -33,15 +33,24 @@ templates, not in Python.
 ### Freezing docs for a release
 
 The site is static (`website/`, no build step). `content/latest` is the editable
-tip; each release gets a frozen copy. Page ids in `content/*/nav.json` are used
-as URLs (`?p=<id>`), so do not rename them.
-
-1. Cut the release as usual.
-2. Copy `website/content/latest/` to `website/content/vX.Y.Z/`.
-3. Add an entry to `website/data/versions.json` with `channel: release`, the
-   `semver` and the release date as `updated`; bump `updated` on `latest`.
-4. Check that every nav id resolves, internal links work and the changelog has a
-   section for that tag.
+tip. Page ids in `content/*/nav.json` are used as URLs (`?p=<id>`), so do not
+rename them.
+
+Docs freezes are **automatic** on release. When `release.yml` cuts a version it
+runs `scripts/freeze-docs.sh vX.Y.Z` before tagging, in the same
+`chore(release): vX.Y.Z` commit as the changelog. That script:
+
+1. Copies `website/content/latest/` → `website/content/vX.Y.Z/`
+2. Copies `website/skills/latest/` → `website/skills/vX.Y.Z/` when present
+3. Inserts the release entry in `website/data/versions.json` and marks the
+   previous release snapshot as `supported`
+
+Do **not** open a follow-up PR just to freeze docs. To dry-run locally:
+
+```bash
+./scripts/freeze-docs.sh vX.Y.Z
+# inspect, then discard the generated paths if you are not cutting a release
+```
 
 ## Security
 

hueman_cli-0.3.1/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: hueman-cli
+Version: 0.3.1
+Summary: Centralized theme manager: one YAML palette feeds Jinja2 templates that generate each tool's config.
+Author: 4DRIAN0RTIZ
+License-Expression: MIT
+Project-URL: Homepage, https://hueman.cuevaneander.tech
+Project-URL: Source, https://github.com/NeanderTeam/hueman
+Project-URL: Issues, https://github.com/NeanderTeam/hueman/issues
+Keywords: theme,colors,palette,dotfiles,jinja2,terminal,cli
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Desktop Environment
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Jinja2>=3.1.6
+Requires-Dist: PyYAML>=6.0.1
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <img src="website/assets/img/logo.png" alt="hueman" width="128" />
+</p>
+
+<h1 align="center">hueman</h1>
+
+<p align="center"><strong>One palette. Every tool.</strong></p>
+
+<p align="center">
+One theme for your terminal, editor, prompt, and the rest of your setup.<br />
+You say which file each app uses, and one command paints them all.<br />
+Not a dotfiles manager: output paths live in your own <code>hueman.config.yaml</code>,
+outside this repo.
+</p>
+
+## Quickstart
+
+```sh
+pipx install hueman-cli                               # or: pip install hueman-cli
+hueman init                                           # sample config → ~/.config/hueman/config.yaml
+# point targets/outputs at your paths, then:
+hueman set <palette> --dry-run
+hueman set <palette>
+```
+
+From source (Python >= 3.9):
+
+```sh
+git clone https://github.com/NeanderTeam/hueman.git
+cd hueman && pip install -e .
+```
+
+Upgrade: `pipx upgrade hueman-cli` (or `pip install -U hueman-cli`).  
+Uninstall: `pipx uninstall hueman-cli` (or `pip uninstall hueman-cli`); your
+config and generated files are left alone (details in the
+[install guide](https://hueman.cuevaneander.tech/?p=install)).
+
+Other commands: `init` (sample config), `list` (palettes), `status` (active
+theme), `sync` (shared state across machines).
+
+Quick reference on the machine: `hueman --help` and `hueman <command> --help`.
+
+## Core ideas
+
+- One palette, many targets; output mapping is declarative.
+- Packaged templates and palettes are defaults; custom dirs win.
+- `overwrite` for full generated files, `patch` for blocks inside hand-edited
+  configs.
+- Per-target `reload` and global `post_apply`, best-effort, with `warn` /
+  `error` policy.
+- Optional sync of the active palette across machines (`state_sync`).
+- To support a new app, add a template and a target.
+
+## Packaged tools
+
+`hueman/palettes/` and `hueman/templates/` ship 25 generic palettes and
+templates for common tools (kitty, tmux, polybar, nvim/nightfox, dunst, bspwm,
+yazi, qutebrowser, rofi, fzf, atuin, oh-my-posh, wezterm, starship, Termux,
+herdr, and more). For other tools, use `template_dirs` in your config instead of
+asking for them to be packaged here.
+
+## Docs
+
+Full site: **[hueman.cuevaneander.tech](https://hueman.cuevaneander.tech)**  
+(`/` = landing, `?p=intro` = docs). For flags and short examples on your
+machine, use `hueman --help` / `hueman set --help` rather than a man page.
+
+Local preview (sources under `website/`):
+
+```sh
+python3 -m http.server 8765 --directory website
+```
+
+then open `http://localhost:8765`.
+
+## Support
+
+Bug or idea? Open an issue at
+[github.com/NeanderTeam/hueman/issues](https://github.com/NeanderTeam/hueman/issues).
+
+## Repo layout
+
+| Path | Contents |
+|---|---|
+| `hueman/cli.py` | CLI and orchestration (`hueman` command) |
+| `hueman/engine/` | Config, palettes, targets, render, reload, shared state |
+| `hueman/palettes/`, `hueman/templates/` | Packaged YAML palettes and Jinja2 templates |
+| `hueman/data/hueman.config.example.yaml` | Commented external config example (`hueman init`) |
+| `tests/` | Test suite |
+| `website/` | Landing + documentation site |
+
+The repo is self-contained: nothing inside imports code from outside itself,
+except the external config each user provides. A dotfiles repo only needs
+`hueman` installed and its own `hueman.config.yaml`.
+
+## License
+
+MIT, see [LICENSE](LICENSE).

hueman_cli-0.3.1/README.md

@@ -0,0 +1,98 @@
+<p align="center">
+  <img src="website/assets/img/logo.png" alt="hueman" width="128" />
+</p>
+
+<h1 align="center">hueman</h1>
+
+<p align="center"><strong>One palette. Every tool.</strong></p>
+
+<p align="center">
+One theme for your terminal, editor, prompt, and the rest of your setup.<br />
+You say which file each app uses, and one command paints them all.<br />
+Not a dotfiles manager: output paths live in your own <code>hueman.config.yaml</code>,
+outside this repo.
+</p>
+
+## Quickstart
+
+```sh
+pipx install hueman-cli                               # or: pip install hueman-cli
+hueman init                                           # sample config → ~/.config/hueman/config.yaml
+# point targets/outputs at your paths, then:
+hueman set <palette> --dry-run
+hueman set <palette>
+```
+
+From source (Python >= 3.9):
+
+```sh
+git clone https://github.com/NeanderTeam/hueman.git
+cd hueman && pip install -e .
+```
+
+Upgrade: `pipx upgrade hueman-cli` (or `pip install -U hueman-cli`).  
+Uninstall: `pipx uninstall hueman-cli` (or `pip uninstall hueman-cli`); your
+config and generated files are left alone (details in the
+[install guide](https://hueman.cuevaneander.tech/?p=install)).
+
+Other commands: `init` (sample config), `list` (palettes), `status` (active
+theme), `sync` (shared state across machines).
+
+Quick reference on the machine: `hueman --help` and `hueman <command> --help`.
+
+## Core ideas
+
+- One palette, many targets; output mapping is declarative.
+- Packaged templates and palettes are defaults; custom dirs win.
+- `overwrite` for full generated files, `patch` for blocks inside hand-edited
+  configs.
+- Per-target `reload` and global `post_apply`, best-effort, with `warn` /
+  `error` policy.
+- Optional sync of the active palette across machines (`state_sync`).
+- To support a new app, add a template and a target.
+
+## Packaged tools
+
+`hueman/palettes/` and `hueman/templates/` ship 25 generic palettes and
+templates for common tools (kitty, tmux, polybar, nvim/nightfox, dunst, bspwm,
+yazi, qutebrowser, rofi, fzf, atuin, oh-my-posh, wezterm, starship, Termux,
+herdr, and more). For other tools, use `template_dirs` in your config instead of
+asking for them to be packaged here.
+
+## Docs
+
+Full site: **[hueman.cuevaneander.tech](https://hueman.cuevaneander.tech)**  
+(`/` = landing, `?p=intro` = docs). For flags and short examples on your
+machine, use `hueman --help` / `hueman set --help` rather than a man page.
+
+Local preview (sources under `website/`):
+
+```sh
+python3 -m http.server 8765 --directory website
+```
+
+then open `http://localhost:8765`.
+
+## Support
+
+Bug or idea? Open an issue at
+[github.com/NeanderTeam/hueman/issues](https://github.com/NeanderTeam/hueman/issues).
+
+## Repo layout
+
+| Path | Contents |
+|---|---|
+| `hueman/cli.py` | CLI and orchestration (`hueman` command) |
+| `hueman/engine/` | Config, palettes, targets, render, reload, shared state |
+| `hueman/palettes/`, `hueman/templates/` | Packaged YAML palettes and Jinja2 templates |
+| `hueman/data/hueman.config.example.yaml` | Commented external config example (`hueman init`) |
+| `tests/` | Test suite |
+| `website/` | Landing + documentation site |
+
+The repo is self-contained: nothing inside imports code from outside itself,
+except the external config each user provides. A dotfiles repo only needs
+`hueman` installed and its own `hueman.config.yaml`.
+
+## License
+
+MIT, see [LICENSE](LICENSE).