Skip to main content

command line app for running configurable shell commands

Project description

plz

Build Status Coverage Status

A shell command to execute standard/repeatable commands in a git repo

Installation

Install plz at the system level so that it only has to be installed once.

pip install plz

# sudo may be required on your machine
sudo pip install plz

It can also be installed inside a virtualenv. However, this means you'll have to install plz for each each virtualenv in use.

virtualenv venv
. venv/bin/activate

pip install plz

Example

plz looks for a plz.config YAML file in the root of the git repo you're currently in. This file can (and should) be checked into version control.

Note: this app does not currently support running plz.config files that are not inside a git repo directory.

Suppose we have a plz.config file in the root of a git repo:

- id: run
  name: runserver
  cmd: ./manage.py runserver
- id: test
  name: test code
  cmd:
  - ./manage.py test
  - yarn test
- id: setup
  name: setup apps
  cmd:
  - pipenv install
  - pipenv run ./manage.py migrate
  - yarn install

The following commands would be available:

plz run
plz test
plz setup

Project details


Download files

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

Files for plz-cmd, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size plz_cmd-0.1.0-py3-none-any.whl (3.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size plz-cmd-0.1.0.tar.gz (3.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page