Python Tools Scripts
Project description
Python Tools Scripts
This is a tool, similar to invoke. It's more recent and uses argparse under the hood and some additional magic to define the CLI arguments.
To use it, you must have a tools
package in your repository root.
On your tools/__init__.py
import your scripts and Python Tools Scripts will add them to it's CLI.
An Example Script tools/vm.py
"""
These commands are used to create/destroy VMs, sync the local checkout
to the VM and to run commands on the VM.
"""
from ptscripts import Context, command_group
# Define the command group
vm = command_group(name="vm", help="VM Related Commands", description=__doc__)
@vm.command(
arguments={
"name": {
"help": "The VM Name",
"metavar": "VM_NAME",
"choices": list(AMIS),
},
"key_name": {
"help": "The SSH key name.",
},
"instance_type": {
"help": "The instance type to use.",
},
"region": {
"help": "The AWS regsion.",
},
}
)
def create(
ctx: Context,
name: str,
key_name: str = None,
instance_type: str = None,
region: str = "eu-central-1",
):
"""
Create VM.
"""
vm = VM(ctx=ctx, name=name)
vm.create(region_name=region, key_name=key_name, instance_type=instance_type)
@vm.command(
arguments={
"name": {
"help": "The VM Name",
"metavar": "VM_NAME",
},
}
)
def destroy(ctx: Context, name: str):
"""
Destroy VM.
"""
vm = VM(ctx=ctx, name=name)
vm.destroy()
The, on your repository root, run:
❯ tools -h
usage: tools [-h] [--debug] {vm} ...
Python Tools Scripts
optional arguments:
-h, --help show this help message and exit
--debug, -d Show debug messages
Commands:
{vm}
vm VM Related Commands
These tools are discovered under `<repo-root>/tools`.
❯ tools vm -h
usage: tools vm [-h] {create,destroy} ...
These commands are used to create/destroy VMs, sync the local checkout to the VM and to run commands on the VM.
optional arguments:
-h, --help show this help message and exit
Commands:
{create,destroy}
create Create VM.
destroy Destroy VM.
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
Close
Hashes for python-tools-scripts-0.13.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e6131c8f443a0a4d744b7edee661f827cc502925a036881224b79af047bad4e |
|
MD5 | 1d2af9c00335d18b3e27eeea08916f3b |
|
BLAKE2b-256 | bc30f095e5974f578d878b0c22bfcd66a1866d70a056fba1d73c044ad8e66679 |
Close
Hashes for python_tools_scripts-0.13.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6834e6856615811c6f27a96e89f178337777502c2acfe81314796890f216b98 |
|
MD5 | 1c2e64c9d7ee14e81fa812dcfdd29573 |
|
BLAKE2b-256 | 20d3929dadd6a4f31da1dcbb6c9050135298d8214c6404a03ba1fa05ccfc2758 |