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

See: major changes in v3.0

pickley allows to install and keep up-to-date standalone pip-installable python CLIs such as tox, twine, etc. A bit like brew or apt, but based solely on pypi

It is similar to pipx, but supports any python (including py2), offers self-auto-upgrade, and can package folders as well (for deployment, as venv or pex currently).

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 (can be pinned via explicit pin pickley install foo==1.0, or via configuration)

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/master/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 tox twine
Installed tox v3.21.4 in 6 seconds 501 ms
Installed twine v3.3.0 in 6 seconds 901 ms

$ which tox
~/.local/bin/tox

$ tox --version
tox version 3.21.4

$ pickley list
| Package    | Version |
-------------|----------
| tox        | 3.21.4  |
| twine      | 3.3.0   |

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:

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

    • install: install specified package(s)

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

    • package: can be used to simplify packaging of python projects for internal use

Installation

Install latest version in ~/.local/bin

Handy one-line using bash:

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

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

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

Install from source

Run (you will need tox):

git clone https://github.com/codrsquad/pickley.git
cd pickley
tox -e venv
.venv/bin/pickley --help

Project details


Download files

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

Source Distribution

pickley-3.3.1.tar.gz (31.4 kB view details)

Uploaded Source

Built Distribution

pickley-3.3.1-py3-none-any.whl (31.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pickley-3.3.1.tar.gz
  • Upload date:
  • Size: 31.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for pickley-3.3.1.tar.gz
Algorithm Hash digest
SHA256 62730d6cde96a0f1b707da95e60f6a89de1515840d8c0ba9c72d6bbe3e9e3ee9
MD5 e9a9194555f3f556c5ec615981df1873
BLAKE2b-256 9b62c7bc77c89d680e7c46b268b24dcac62c39ad379abbdd0070dc313f81bd28

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pickley-3.3.1-py3-none-any.whl
  • Upload date:
  • Size: 31.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for pickley-3.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5b8e6cc70d94b9507dc76135721a86bdde5b6116322cf69fcc3547c914ec510b
MD5 5ed706225feacc350384e335d2bc8c13
BLAKE2b-256 79e9e66f099538bdcb03b8885cac79982df6bba29cccf0691ef9f708a2fbd2f9

See more details on using hashes here.

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