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.
3 maintainers
Metadata
3 maintainers
Release files for python-tools-scripts 0.20.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| python-tools-scripts-0.20.5.tar.gz | 31.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| python_tools_scripts-0.20.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 55.6 kB
Release files / python-tools-scripts-0.20.5.tar.gz
| Download URL | python-tools-scripts-0.20.5.tar.gz |
|---|---|
| Size | 31.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c2a3ffb6a0ec6ccb3cfe0bee1ae73447d3ea4ba7583b07fa219d2dddaff4a36e
|
|
BLAKE2b-256 checksum How to use checksums |
184d9aae16821648c0019e4b989a216548a56d4e3af9ce3a8e711802e873cae2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.8.12
|
Release files / python_tools_scripts-0.20.5-py3-none-any.whl
| Download URL | python_tools_scripts-0.20.5-py3-none-any.whl |
|---|---|
| Size | 24.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a2c88c2d14537432ed0b0513f8025e2f67b2a5da8b00d465a2ae2de7e7dd6b08
|
|
BLAKE2b-256 checksum How to use checksums |
9d7fcb725bf93405f0a7f8e0840890674820cf6407f097ad52b13926cb9e42b5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.8.12
|
