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.20.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e22a7048fb3e5f1457de8168cf53d6e12f0f2c2ea02bc94c2d5ca777e267290c |
|
MD5 | 0a22307036378fb71a6557714e1492b9 |
|
BLAKE2b-256 | 96098d1dd68169576777c32c73ec9e41b9ec87114a393936164631540496ef2f |
Close
Hashes for python_tools_scripts-0.20.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c48d5cdc92c4b0a9b44d8d402ad0fbea274fa0ad6e534ed78749c17df9cfa200 |
|
MD5 | 62040e65afdd23fe6187b6878f2f4a03 |
|
BLAKE2b-256 | df8ce9bcd92709b7f644a06cb61638488f08223e22701e396e501da26dd0401b |