fortscript 0.2.1

A process supervisor with execution control based on system resource state.

FortScript

A process supervisor with execution control based on system resource state.

English | Português

Table of Contents

• 1. The Library
  • Installation
  • Quick Start
  • Why use the library?
  • Usage Examples
  • Configuration Options
• 2. CLI
• Roadmap & Features
• Contributing
• License

FortScript is a Python Process Manager, based on RAM monitoring and OS process detection, that automatically starts, pauses, and terminates applications using reactive resource consumption policies.

---

1. The Library

FortScript can be integrated into any Python project as a library to manage child processes and monitor system health.

Installation

pip install fortscript

Quick Start

from fortscript import FortScript

# Initialize with a configuration file
app = FortScript(config_path="my_config.yaml")

# Run the management loop
app.run()

Why use the library?

• Clean Lifecycle: Safely start and stop child processes (including full process trees).
• Resource Monitoring: Built-in hooks for RAM usage and process activity.
• Multi-Runtime: Supports Python, Node.js (pnpm), and native Executables.

1. Managing Independent Modules

You can use FortScript as a central controller for various scripts scattered across your system.

config.yaml:

# List of projects to be managed
projects:
  - name: "Trading Bot"
    path: "C:/Users/Dev/Finance/bot.py"
  - name: "Server Monitor"
    path: "C:/Users/Dev/Server/monitor.js"

# Processes that, when detected, will pause your projects
heavy_processes:
  - name: "Fortnite"
    process: "fortnite"
  - name: "Video Editor"
    process: "resolve"

# RAM usage percentage threshold to trigger safe shutdown
ram_threshold: 90

2. Integration in Larger Projects

Import FortScript in your main application entry point to automatically handle background tasks.

# main_controller.py
from fortscript import FortScript

def start_services():
    # Detects games/heavy apps and pauses these services automatically
    manager = FortScript(config_path="./services_config.yaml")
    manager.run()

Configuration Options

The config.yaml file supports the following fields:

Field	Description	Type	Default
projects	List of applications to manage. Each item needs a name and path.	List	[]
heavy_processes	List of processes that trigger a pause. Each item needs a name and process (substring of the executable name).	List	[]
ram_threshold	Maximum RAM usage percentage allowed before stopping scripts.	Integer	80

---

2. CLI

The CLI is an interface designed for a broad audience, allowing for easy process management.

Usage

If you are developing locally:

uv run fort

After installation, simply run:

fort

• Configuration: The CLI looks for a config.yaml file in the same directory as the script.
• Auto-detection: Soon, it will be possible to add the main initialization script to the CLI by running a single command inside the project folder.

---

Roadmap & Features

The following list tracks the progress of our features and future implementations:

• Monitor Heavy Processes: Detection of resource-intensive applications.
• RAM Usage Monitoring: Automatic triggers based on memory percentage.
• Unified Script Runner:
  • Native Executables (.exe)
  • Python Scripts (.py)
  • JavaScript/TypeScript Projects (package.json)
• System Integration:
  • Auto-start with Windows/Linux.
  • System Tray (Icon) support for background operation.
• Smart Interruption:
  • Auto-stop when heavy processes are detected.
  • Auto-resume when processes are closed.
  • RAM-based stop/resume cycling.

---

Contributing

Contributions are welcome! Please read our Contribution Guide for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Developed with ❤️ by WesleyyDev