P is for project. As in, "How the hell do I work on this project."
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
p
scripts
.gitignore
LICENSE
README.md
setup.py

README.md

p

P is a command line tool that gathers up all of the available commands/scripts for a project, and aliases them to p <name>. Running p by itself will list out all of the known commands. If you personally start using p, you'll probably find that p is the first thing you run after cd <project> to get your bearings and start doing work.

Read more here.

Example

$ cd project
$ p
Usage: p [OPTIONS] COMMAND [ARGS]...

Options:
--version
--list
--help     Show this message and exit.

Commands:
compile-assets  Using: ./scripts/compile-assets
install         Using: yarn install && pipenv sync --dev
load-fixtures   Using: ./scripts/load-fixtures
pre-commit      Using: ./scripts/pre-commit
test            Using: ./scripts/test
work            Using: combine work

Why?

  • Context switching sucks.
  • New contributors don't always know where to start.
  • To help remind us that developer experience is important, and to take the time to add commands/scripts to your project to make life easier for you and your contributors.

Install it for yourself

# system-wide or user-wide, not per project
$ pip3 install -U git+https://github.com/dropseed/p.git#egg=p