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.18.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3aa8a14047aa7be39a8c2111db229787602f4424bd96a066fd43d31884525206 |
|
MD5 | 50dc6e165b42d15a3b97b9bc78a3762f |
|
BLAKE2b-256 | 4434d007cdf693fe810c8b01804f0dadeb99150ece67ffa8be310f231b2265c5 |
Close
Hashes for python_tools_scripts-0.18.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e05875a0cdd6515c7d7da11aa2e362efb3e91d88348f35e36e1d174bd0e1890 |
|
MD5 | ef19dfa29590e570359472f12589ca64 |
|
BLAKE2b-256 | c985dc9767e8c0590a8aa0c706d98001daa869b56f8fe0ebd61d950aa5dac50b |