Skip to main content

Automate installation of standalone python CLIs

Project description

Automate installation of standalone python CLIs

Version on pypi Tested with Github Actions Test code codecov Python versions tested (link to github project)

Overview

pickley allows to install and keep up-to-date standalone pip-installable python CLIs such as tox, hatch, etc.

It is similar to pipx, main difference being installed CLIs automatically self-upgrade as you use them.

It can work out of the box, without any configuration:

  • pickley is portable, it will run and install other CLIs in the same folder it’s running from (drop it in ~/.local/bin or /usr/local/bin for example)

  • All pypi packages with console_scripts entry point(s) can be immediately installed

  • Latest non-prerelease pypi version will be installed by default

  • Any specification acceptable to pip install can be stated, for example:

    pickley install tox  # track latest version
    
    pickley install 'tox>0a0'  # track pre-releases as well
    
    pickley install 'tox<4'  # track latest version that is strictly less than v4
    
    pickley install tox==3.24.3  # pin to a specific version
    
    pickley install tox~=3.28  # track version range
    
    pickley install git+https://...@some-branch  # track a git branch

With some configuration, the following becomes possible:

  • You can pin what version to install, what python to use etc, per pypi package

  • You can define bundle-s: names that install several pypi packages at once, for example: you could define a bundle:dev to install tox pipenv pre-commit

  • You can use a custom pypi server index (pip’s default is respected by default)

  • You can use the symlink delivery method, which will use symlinks instead of self-upgrading wrapper

Example

Once you have pickley, you can get other python CLIs and use them as standalone programs, for example:

# One-liner to grab pickley, and drop it in ~/.local/bin
$ curl -fsSL https://raw.githubusercontent.com/codrsquad/pickley/main/src/pickley/bstrap.py | /usr/bin/python3 -

# Double-check you do have ~/.local/bin in your PATH
$ which -a pickley
~/.local/bin/pickley

$ pickley base
~/.local/bin

$ pickley install install tox 'hatch<2'
Installed tox v4.21.2 in 1 second 4 ms
Installed hatch v1.12.0 in 1 second 791 ms

$ which tox
~/.local/bin/tox

$ tox --version
4.21.2 from .../.pk/tox-4.21.2/...

$ pickley list
| Package | Version | PM | Python           |
----------|---------|----|-------------------
| hatch   | 1.12.0  | uv | /usr/bin/python3 |
| tox     | 4.21.2  | uv | /usr/bin/python3 |
| uv      | 0.4.20  | uv | /usr/bin/python3 |

$ pickley list -v
| Package | Version | PM | Python           | Delivery | Track   |
----------|---------|----|------------------|----------|----------
| hatch   | 1.12.0  | uv | /usr/bin/python3 | wrap     | hatch<2 |
| tox     | 4.21.2  | uv | /usr/bin/python3 | wrap     | tox     |
| uv      | 0.4.20  | uv | /usr/bin/python3 | wrap     | uv      |

Configuration

See config

Features

  • Any pypi package that has console_scripts entry point can be installed and kept up-to-date

  • Aims to work with zero configuration (but configuration is possible):

    • entirely portable, installations are performed in the same folder where pickley resides, drop it in ~/.local/bin and all the stuff you install with it will also be there

    • latest non pre-release version from pypi is used

Commands

  • install: Install specified package(s)

  • uninstall: Uninstall specified package(s)

  • upgrade: Upgrade specified package(s)

  • check: Exit with code 0 if specified package(s) are up-to-date

  • list: List installed packages via pickley, in folder where it resides (not globally)

  • base: Print the base folder where pickley resides

  • config: Show current configuration

  • describe: Describe a package spec (version and entrypoints)

  • diagnostics: Show diagnostics info

  • run: Run a python CLI (auto-install it if needed)

  • bootstrap: Install pickley itself in target base folder

Installation

Install latest version in ~/.local/bin

Handy one-line using bash:

$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/codrsquad/pickley/main/get-pickley)"

Handy one-liner using python (see --help, the script accepts a few options):

$ curl -fsSL https://raw.githubusercontent.com/codrsquad/pickley/main/src/pickley/bstrap.py | /usr/bin/python3 - --help

If you happen to have uv already installed (anywhere), you can run:

$ uvx pickley bootstrap ~/.local/bin

Install from source

Run (you will need tox):

git clone https://github.com/codrsquad/pickley.git
cd pickley
uv venv
uv pip install -r requirements.txt -r tests/requirements.txt -e .
.venv/bin/pickley --help

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pickley-4.4.1.tar.gz (44.8 kB view details)

Uploaded Source

Built Distribution

pickley-4.4.1-py3-none-any.whl (37.3 kB view details)

Uploaded Python 3

File details

Details for the file pickley-4.4.1.tar.gz.

File metadata

  • Download URL: pickley-4.4.1.tar.gz
  • Upload date:
  • Size: 44.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pickley-4.4.1.tar.gz
Algorithm Hash digest
SHA256 39b3310a4b135387a4777a086cb9325eb7222c7324c0814b3dc91d0bb3080c84
MD5 2c4139a6288d81aa2ebb532815b72b47
BLAKE2b-256 155e135a0c9bb75572ada2469f5dd3448cbcf0e0b2ec79a68a057aeb33c18751

See more details on using hashes here.

Provenance

The following attestation bundles were made for pickley-4.4.1.tar.gz:

Publisher: release.yml on codrsquad/pickley

Attestations:

File details

Details for the file pickley-4.4.1-py3-none-any.whl.

File metadata

  • Download URL: pickley-4.4.1-py3-none-any.whl
  • Upload date:
  • Size: 37.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pickley-4.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ff9a93667a46c25534fedc00a7f5f432f4e5c18be131ee9299f1e12c62edfb9f
MD5 1aee0baa5db9698739b82899048167d9
BLAKE2b-256 c3f96b24041601e6969867ef0731e00c08f51c1828cd7848d2004a31c62eee85

See more details on using hashes here.

Provenance

The following attestation bundles were made for pickley-4.4.1-py3-none-any.whl:

Publisher: release.yml on codrsquad/pickley

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page