am3

am3

AM3 = Application Manager written with python 3

🦮 Table of Contents

• am3
  • 🦮 Table of Contents
  • 🔧 Installation
  • 📖 (Basic) Usage
    • List Applications
    • Start an Application
      • Specify the main script or file
      • Specify a custom interpreter
      • Start executable files directly
    • Stop an Application
  • ⚙️ Advanced Parameters
    • Generate Configuration
    • Load Configuration
    • Restart Keywords
    • Set Working Directory
    • Set Restart Delay
    • Use Regular Expressions for Restart Keywords
    • Restart Check Delay
    • Pre-Execution Environment Check
    • Assign Application Name
• 🙏 Thanks

🔧 Installation

Python3 is required, which should be available on most of the modern Linux distributions.

Install am3 with this command:

pip install am3

Then you can use it with am or am3.

📖 (Basic) Usage

List Applications

Retrieve and display information about running applications, including their name, ID, and other details.

am3 ls

Start an Application

Launch an application by specifying a command and parameters:

am --start "ping" --params "127.0.0.1 -c 5"

By default, am3 will automatically restart the application if it exits unexpectedly. Each application is assigned a unique ID, which can be used to manage or interact with the application.

Specify the main script or file

Use the -s option to specify the main script or file. If the script is a Python file, the Python interpreter is automatically invoked. Similarly, shell scripts are executed using Bash. This behavior is defined in the guess_interpreter function.

am -s example/counter.py

Specify a custom interpreter

If needed, you can explicitly define the interpreter using the -i option:

am -s example/counter.py -i python3

Start executable files directly

If you’re running the executable in the current directory, use:

./am -s example/counter.py -i python3

Alternatively, you can use symbolic links for starting executables:

am -s example/counter.py

Stop an Application

Terminate a running application by using its ID:

am stop 0

⚙️ Advanced Parameters

Generate Configuration

You can save the configuration for reuse with the -g option:

am -s example/counter.py -i python3 -g example/counter_config.json

Load Configuration

To reuse a previously saved configuration file, use:

am -c example/counter_config.json

Restart Keywords

Define specific keywords that trigger automatic restarts if they appear in the application output:

am -s example/counter.py -i python3 --restart_keyword "Exception XXX" "Exception YYY" -g example/counter_config.json

Set Working Directory

Specify the working directory for the application:

am -s counter.py -i python3 --restart_keyword "Exception XXX" "Exception YYY" -d "/home/nate/gitRepo/am3/example/" -g example/counter_config.json

Set Restart Delay

Define a delay (in seconds) before restarting the application:

am -s counter.py -i python3 --restart_keyword "Exception XXX" "Exception YYY" -d "/home/nate/gitRepo/am3/example/" -t 3 -g example/counter_config.json

Use Regular Expressions for Restart Keywords

Specify regular expressions as restart keywords for more flexible matching:

am -s counter.py -i python3  --restart_keyword "Exception XXX" --restart_keyword "Exception YYY" \
  --restart_keyword_regex "| 0.00 |" --restart_keyword_regex "2\\d\\.\\d\\d KB/s" \
  -d "/home/nate/gitRepo/am3/example/" -t 3 -g example/counter_config.json

Restart Check Delay

Set a delay for how often to check if the application should restart:

am -s counter.py -i python3 --restart_check_delay 0 --restart_keyword "Exception XXX" \
  --restart_keyword "Exception YYY" --restart_keyword_regex "| 0.00 |" \
  --restart_keyword_regex "2\\d\\.\\d\\d KB/s" \
  -d "/home/nate/gitRepo/am3/example/" -t 3 -g example/counter_config.json

Pre-Execution Environment Check

Run a pre-check script to validate the environment before executing the main application. The script's check function is automatically called every second until it returns True.

am -s counter.py -i python3 --restart_check_delay 0 --restart_keyword "Exception XXX" \
  --restart_keyword "Exception YYY" --restart_keyword_regex "| 0.00 |" \
  --restart_keyword_regex "2\\d\\.\\d\\d KB/s" -d "/home/nate/gitRepo/am3/example/" \
  -t 3 -b "example/counter_before_execute.py" -g example/counter_config.json

Assign Application Name

You can specify a custom name for the application:

am -s counter.py -i python3 --restart_check_delay 0 --restart_keyword "Exception XXX" \
  --restart_keyword "Exception YYY" --restart_keyword_regex "| 0.00 |" \
  --restart_keyword_regex "2\\d\\.\\d\\d KB/s" -d "/home/nate/gitRepo/am3/example/" \
  -t 3 -b "example/counter_before_execute.py" --name counter -g example/counter_config.json

🙏 Thanks

Thanks for the great IDE Pycharm from Jetbrains.