AsyncIO-powered python DSL for running commands locally, on docker, or over ssh.
Project description
🔧 Pitcrew
AsyncIO-powered python DSL for running commands locally, on docker, or over ssh.
What does Pitcrew do?
Pitcrew can run commands |
$ crew sh date
|
...or over ssh |
$ crew sh -p providers.ssh -P '{"hosts": ["192.168.0.1"]}' date
|
on hundreds of hosts! |
$ crew sh -p providers.ssh -P '{"hosts": ["192.168.0.1-100"]}' date
|
Crew can also run tasks |
$ crew run install.homebrew
|
Tasks are either other shell commands, or other tasks, for example, this provisions Cloudfront, SSL and S3 and builds and deploys docs to pitcrew.io |
$ crew run examples.deploy_pitcrew
|
You can list available tasks |
$ crew list
|
...edit an existing task |
$ crew edit examples.deploy_pitcrew
# opens in $EDITOR
|
or create a new task! |
$ crew new some.new.task
|
Installation
From binary
To install pitcrew in your home directory, run the following:
curl -fsSL "https://github.com/joshbuddy/pitcrew/releases/latest/download/crew-$(uname)" > crew
chmod u+x crew
./crew run crew.install --dest="$HOME/crew"
From PyPi
To install from the Python Package Index, run the following:
pip install pitcrew
crew run crew.install --dest="$HOME/crew"
From source
git clone https://github.com/joshbuddy/pitcrew
cd pitcrew
python3.6 -m venv env
env/bin/pip installer -r requirements.txt
Concepts
A command or set of commands is called a task. A context runs tasks either locally, on docker or over ssh. A provider generates contexts.
Tasks
Tasks are either composed from other tasks or invoking a command on a shell.
An example of a task might be reading a file. fs.read(path)
reads a file as bytes and returns it:
pitcrew/tasks/fs/read.py
import base64
from pitcrew import task
@task.arg("path", desc="The file to read", type=str)
@task.returns("The bytes of the file")
class FsRead(task.BaseTask):
"""Read value of path into bytes"""
async def run(self) -> bytes:
code, out, err = await self.sh_with_code(f"cat {self.params.esc_path}")
assert code == 0, "exitcode was not zero"
return out
Other tasks might include writing a file, installing xcode or cloning a git repository. All the currently available tasks are listed at docs/tasks.md. The api available in a task is available at docs/api.md#crewtask.
Contexts
An example of a context might be over ssh, or even locally. Learn more about contexts at docs/api.md#crewcontext.
Providers
A provider is a task with a specific return type. The return type is an async iterator which returns contexts.
Usage
For detailed usage, see docs/cli.md for more details.
Run a command
Pitcrew allows running a command using bin/crew sh -- [shell command]
.
For example crew sh ls /
will list the "/" directory locally.
You can run this across three hosts via ssh using crew sh -p providers.ssh -P '{"hosts": ["192.168.0.1", "192.168.0.2", "192.168.0.3"]}' ls /
.
Run a task
Pitcrew allows running a task using crew run [task name] <task args>
. This will normally target your local machine unless you use the -p
flag to select a different provider.
See available tasks
To see all the available tasks run crew list
. This will show all available tasks which are stored in crew/tasks
.
Make a new task
To see all the available tasks run crew new [task_name]
. This will create a template of a new task.
Run tests
To run an ad-hoc command use . For tasks use crew run [task-name] <args>
.
Get CLI help
To see the whole list of commands available from the command-line, run crew help
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pitcrew-0.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b1f479f656bc888e4f5b58bd2970f8ccbd81c32bb0cf19688f1ccd495ef5f9d |
|
MD5 | 4080229f225fe4e2a5c134ccf9810be1 |
|
BLAKE2b-256 | 3f2a6d376a990c3debe8f906309af1db521301dae6c521c8ede52ca935246113 |