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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 91176ea684cce30e1ac515f4cfc51219923f01b637e2d4681847e75adf9ef90a |
|
MD5 | 7ab0068e0afea1ebadeefb85ea140d83 |
|
BLAKE2b-256 | b1f29de50aeef7a3cd56da3e3832e42b4bb8fe0813037712c5d0a87c62dd62b6 |
Close
Hashes for python_tools_scripts-0.20.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30fb1aa93c3938c080efb12d89355ba552dd671e1da19282c89fa09fc8cc50bb |
|
MD5 | 60a142efc9b0c401c5b9cfd20065270f |
|
BLAKE2b-256 | cbfb875467bc30ed1bdeabf0563e28d4ea2f60b18ed5456a12308d067ed5dd05 |