Skip to content

Commit

Permalink
Merge branch 'release/0.3.13'
Browse files Browse the repository at this point in the history
  • Loading branch information
AndydeCleyre committed Jan 16, 2025
2 parents 0c86e52 + 9e79ef2 commit 075e013
Show file tree
Hide file tree
Showing 20 changed files with 915 additions and 643 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ctnrs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ jobs:
- name: push container images
run: |
for img in $(podman images -n -f reference=andykluger --format={{.Repository}}:{{.Tag}}); do
for img in $(podman images -n -f reference='andykluger/*' --format={{.Repository}}:{{.Tag}}); do
podman push "$img"
done
16 changes: 16 additions & 0 deletions NEWS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@
News
====

0.3.13
======

Changed
-------

- Ensure Zsh is used for fzf/skim preview commands, even with ``SHELL`` unset (or set to something other than Zsh)
- Refresh docs:

- add mise hooks and combination methods
- replace deprecated tabs and admonitions
- use filename code block titles
- use newer pypc behavior for screenshot, replacing outdated gif

0.3.12
======

Expand Down Expand Up @@ -31,6 +45,7 @@ Changed
- Remove useless double-zsh-invocation during fzf/skim preview
- Exclude wheel from pipcheckold listings
- Use new wheezy.template feature (``__args__``) to reduce shell-manipulation of JSON

- If using the wheezy.template JSON-reading backend, upgrade it (``pipz upgrade wheezy.template``)!

0.3.10
Expand Down Expand Up @@ -110,6 +125,7 @@ Changed
-- It's been pip-tools' default for while already,
and it's irrelevant to uv
- Update container build scripts:

- use newer base images
- install uv and rich-cli
- don't bother installing highlight and corresponding alias
Expand Down
20 changes: 20 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,26 @@ __ https://flit.readthedocs.io/en/latest/

__ https://github.com/AndydeCleyre/zpy/issues

Known Issues
------------

Functions ``pipacs``, ``pipac``, ``pipcs``, and ``pipc`` allow forwarding arguments directly
to ``pip-compile``, or ``uv pip compile`` when ``uv`` is installed.

There are currently two problems with this when ``uv`` is used:

- Tab completion of those arguments, even when ``uv`` tab completions are installed, will fail.
If it bothers you, please add a 👍 on
`their existing issue`__.
- When the options passed are intended to override ones already passed internally,
the command will fail.
If this bothers you, please add a 👍 on
`their existing issue`__.

__ https://github.com/astral-sh/uv/issues/3249

__ https://github.com/astral-sh/uv/issues/3248

.. |repo| image:: https://img.shields.io/github/size/andydecleyre/zpy/zpy.plugin.zsh?logo=github&label=Code&color=blueviolet
:alt: Plugin file size in bytes
:target: https://github.com/andydecleyre/zpy
Expand Down
6 changes: 3 additions & 3 deletions doc/mkdocs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ repo_url: https://github.com/andydecleyre/zpy
docs_dir: ../src
# site_dir:
markdown_extensions:
- admonition
- footnotes
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.blocks.admonition
- pymdownx.blocks.tab:
alternate_style: True
plugins:
- privacy
theme:
Expand Down
16 changes: 8 additions & 8 deletions doc/mkdocs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
babel==2.16.0 # via mkdocs-material
certifi==2024.8.30 # via requests
charset-normalizer==3.4.0 # via requests
click==8.1.7 # via mkdocs
certifi==2024.12.14 # via requests
charset-normalizer==3.4.1 # via requests
click==8.1.8 # via mkdocs
colorama==0.4.6 # via mkdocs-material
ghp-import==2.1.0 # via mkdocs
idna==3.10 # via requests
jinja2==3.1.4 # via mkdocs, mkdocs-material
jinja2==3.1.5 # via mkdocs, mkdocs-material
markdown==3.7 # via mkdocs, mkdocs-material, pymdown-extensions
markupsafe==3.0.2 # via jinja2, mkdocs
mergedeep==1.3.4 # via mkdocs, mkdocs-get-deps
mkdocs==1.6.1 # via -r requirements.in, mkdocs-material
mkdocs-get-deps==0.2.0 # via mkdocs
mkdocs-material==9.5.48 # via -r requirements.in
mkdocs-material==9.5.49 # via -r requirements.in
mkdocs-material-extensions==1.3.1 # via mkdocs-material
packaging==24.2 # via mkdocs
paginate==0.5.7 # via mkdocs-material
pathspec==0.12.1 # via mkdocs
platformdirs==4.3.6 # via mkdocs-get-deps
pygments==2.18.0 # via mkdocs-material
pymdown-extensions==10.12 # via mkdocs-material
pygments==2.19.1 # via mkdocs-material
pymdown-extensions==10.14 # via mkdocs-material
python-dateutil==2.9.0.post0 # via ghp-import
pyyaml==6.0.2 # via mkdocs, mkdocs-get-deps, pymdown-extensions, pyyaml-env-tag
pyyaml-env-tag==0.1 # via mkdocs
regex==2024.11.6 # via mkdocs-material
requests==2.32.3 # via mkdocs-material
six==1.17.0 # via python-dateutil
urllib3==2.2.3 # via requests
urllib3==2.3.0 # via requests
watchdog==6.0.0 # via mkdocs
6 changes: 3 additions & 3 deletions doc/src/completions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
If you've been using Zsh, you probably have completions already set up,
either manually or with a framework.

If not, at a minimum you'll want this in your `~/.zshrc`,
If not, at a minimum you'll want this line in your `~/.zshrc`,
somewhere before loading zpy:

```shell
```shell {title=".zshrc"}
autoload -Uz compinit && compinit
```

I'll also recommend:

```shell
```shell {title=".zshrc"}
zstyle ':completion:*' menu select
```

Expand Down
200 changes: 113 additions & 87 deletions doc/src/deps.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,106 +4,132 @@ The primary requirements are Zsh, Python, and
[`fzf`](https://github.com/junegunn/fzf) *or* [`sk` (skim)](https://github.com/skim-rs/skim),
with optional additions for more colorful output, alternative json parsers, and faster performance.

`uv` is strongly recommended, and can be installed after zpy, with zpy:

```console
% pipz install uv
```

## Suggested Dependencies by Platform

=== "Alpine"
/// tab | Alpine

```console
$ sudo apk add fzf pcre2-tools python3 zsh
```

///

/// tab | Arch

```console
$ sudo pacman -S --needed fzf python zsh
```

///

/// tab | Debian/Ubuntu

```console
$ sudo apk add fzf pcre2-tools python3 zsh
```
```console
$ sudo apt --no-install-recommends install fzf python3{,-venv} wget zsh
```

=== "Arch"
///

```console
$ sudo pacman -S --needed fzf python zsh
```
/// tab | Fedora

=== "Debian/Ubuntu"
```console
$ sudo dnf --setopt=install_weak_deps=False install diffutils fzf python3 zsh
```

```console
$ sudo apt --no-install-recommends install fzf python3{,-venv} wget zsh
```
///

=== "Fedora"
/// tab | MacOS

```console
$ sudo dnf --setopt=install_weak_deps=False install diffutils fzf python3 zsh
```
```console
$ brew install fzf pcre2 python zsh
```

=== "MacOS"
///

```console
$ brew install fzf pcre2 python zsh
```
/// tab | OpenSUSE

=== "OpenSUSE"
```console
$ sudo zypper in curl diffutils fzf python3 zsh
```

```console
$ sudo zypper in curl diffutils fzf python3 zsh
```
///

## All Dependencies

=== "The big ones"

- [Zsh](https://repology.org/project/zsh/versions)
- [Python](https://repology.org/project/python/versions)
- [`fzf`](https://github.com/junegunn/fzf) *or* [`sk` (skim)](https://github.com/skim-rs/skim)

=== "The optional ones"

- [uv](https://github.com/astral-sh/uv/)
-- for faster performance, leaner venvs, and more operational feedback
- [highlight](https://repology.org/project/highlight/versions)
*or* [gat](https://github.com/koki-develop/gat/)
*or* [bat](https://repology.org/project/bat/versions)
*or* [rich-cli](https://github.com/Textualize/rich-cli)
-- for pretty syntax highlighting; rich-cli adds fancy tables
- [riff](https://github.com/walles/riff)
*or* [diffr](https://github.com/mookid/diffr)
*or* [delta](https://github.com/dandavison/delta)
*or* [diff-so-fancy](https://github.com/so-fancy/diff-so-fancy)
*or* [colordiff](https://repology.org/project/colordiff/versions)
-- for more pretty syntax highlighting
- [jq](https://repology.org/project/jq/versions)
*or* [wheezy.template](https://github.com/akornatskyy/wheezy.template)
-- for faster JSON parsing
- [jq](https://repology.org/project/jq/versions)
*or* [dasel](https://github.com/TomWright/dasel)
-- for faster JSON writing
- [zsh-defer](https://github.com/romkatv/zsh-defer)
-- for caching help content to eliminate a small delay in the first help message

!!! tip

Some of these can be installed after installing zpy, with zpy's `pipz` command:

```console
% pipz install uv rich-cli wheezy.template
```

=== "The ones you already have anyway, probably"

- `du`, `mktemp`, `md5sum` *or* `md5`, and `nproc` *or* `sysctl` -- provided by
[coreutils](https://repology.org/project/coreutils/versions),
[busybox](https://repology.org/project/busybox/versions),
[toybox](https://repology.org/project/toybox/versions),
BSD,
or macOS
- `diff` -- provided by
[diffutils](https://repology.org/project/diffutils/versions),
[uutils/diffutils](https://github.com/uutils/diffutils),
[busybox](https://repology.org/project/busybox/versions),
BSD,
or macOS
- `wget` *or* `curl` -- provided by
[wget](https://repology.org/project/wget/versions),
[curl](https://repology.org/project/curl/versions),
[busybox](https://repology.org/project/busybox/versions),
or macOS
- a pcre tool -- provided by
pcregrep/pcre-tools,
pcre2grep/pcre2-tools,
[ripgrep (>=14.0.0)](https://repology.org/project/ripgrep/versions),
[ugrep](https://repology.org/project/ugrep/versions),
or Zsh with pcre enabled
/// tab | The big ones

- [Zsh](https://repology.org/project/zsh/versions)
- [Python](https://repology.org/project/python/versions)
- [`fzf`](https://github.com/junegunn/fzf) *or* [`sk` (skim)](https://github.com/skim-rs/skim)

///

/// tab | The optional ones

- [uv](https://github.com/astral-sh/uv/)
-- for faster performance, leaner venvs, and more operational feedback
- [highlight](https://repology.org/project/highlight/versions)
*or* [gat](https://github.com/koki-develop/gat/)
*or* [bat](https://repology.org/project/bat/versions)
*or* [rich-cli](https://github.com/Textualize/rich-cli)
-- for pretty syntax highlighting; rich-cli adds fancy tables
- [riff](https://github.com/walles/riff)
*or* [diffr](https://github.com/mookid/diffr)
*or* [delta](https://github.com/dandavison/delta)
*or* [diff-so-fancy](https://github.com/so-fancy/diff-so-fancy)
*or* [colordiff](https://repology.org/project/colordiff/versions)
-- for more pretty syntax highlighting
- [jq](https://repology.org/project/jq/versions)
*or* [wheezy.template](https://github.com/akornatskyy/wheezy.template)
-- for faster JSON parsing
- [jq](https://repology.org/project/jq/versions)
*or* [dasel](https://github.com/TomWright/dasel)
-- for faster JSON writing
- [zsh-defer](https://github.com/romkatv/zsh-defer)
-- for caching help content to eliminate a small delay in the first help message

/// tip

Some of these can be installed after installing zpy, with zpy's `pipz` command:

```console
% pipz install uv rich-cli wheezy.template
```

///

///

/// tab | The ones you already have anyway, probably

- `du`, `mktemp`, `md5sum` *or* `md5`, and `nproc` *or* `sysctl` -- provided by
[coreutils](https://repology.org/project/coreutils/versions),
[busybox](https://repology.org/project/busybox/versions),
[toybox](https://repology.org/project/toybox/versions),
BSD,
or macOS
- `diff` -- provided by
[diffutils](https://repology.org/project/diffutils/versions),
[uutils/diffutils](https://github.com/uutils/diffutils),
[busybox](https://repology.org/project/busybox/versions),
BSD,
or macOS
- `wget` *or* `curl` -- provided by
[wget](https://repology.org/project/wget/versions),
[curl](https://repology.org/project/curl/versions),
[busybox](https://repology.org/project/busybox/versions),
or macOS
- a pcre tool -- provided by
pcregrep/pcre-tools,
pcre2grep/pcre2-tools,
[ripgrep (>=14.0.0)](https://repology.org/project/ripgrep/versions),
[ugrep](https://repology.org/project/ugrep/versions),
or Zsh with pcre enabled

///
Loading

0 comments on commit 075e013

Please sign in to comment.