pgctl: the playground controller¶
Release v3.0. (Installation)
Introduction¶
pgctl
is an MIT Licensed tool to manage developer “playgrounds”.
Often projects have various processes that should run in the backround (services) during development. These services amount to a miniature staging environment that we term playground. Each service must have a well-defined state at all times (it should be starting, up, stopping, or down), and should be independantly restartable and debuggable.
pgctl
aims to solve this problem in a unified, language-agnostic
framework (although the tool happens to be written in Python).
As a simple example, let’s say that we want a date service in our playground, that ensures our now.date file always has the current date.
$ cat playground/date/run
date > now.date
$ pgctl start
$ pgctl status
date -- up (0 seconds)
$ cat now.date
Fri Jun 26 15:21:26 PDT 2015
$ pgctl stop
$ pgctl status
date -- down (0 seconds)
Feature Support¶
- User-friendly Command Line Interface
- Simple Configuration
- Python 2.7—3.5
User Guide¶
This part of the documentation covers the step-by-step
instructions and usage of pgctl
for getting started quickly.
API Documentation¶
If you are looking for information on a specific function, class or method, this part of the documentation is for you.
Contributor Guide¶
If you want to contribute to the project, this part of the documentation is for you.