feat: refactor project and process configurations for improved readability and maintainability across multiple examples

Author: WesleyQDev

README.md

@@ -140,16 +140,22 @@ You can pass all configurations directly in Python code without needing a YAML f
 ```python
 from fortscript import FortScript, RamConfig
 
+projects = [
+    {"name": "My Bot", "path": "./bot/main.py"},
+    {"name": "Node API", "path": "./api/package.json"},
+]
+
+heavy_processes = [
+    {"name": "GTA V", "process": "gta5"},
+    {"name": "OBS Studio", "process": "obs64"},
+]
+
+ram_config = RamConfig(threshold=90, safe=80)
+
 app = FortScript(
-    projects=[
-        {"name": "My Bot", "path": "./bot/main.py"},
-        {"name": "Node API", "path": "./api/package.json"},
-    ],
-    heavy_process=[
-        {"name": "GTA V", "process": "gta5"},
-        {"name": "OBS Studio", "process": "obs64"},
-    ],
-    ram_config=RamConfig(threshold=90, safe=80),
+    projects=projects,
+    heavy_process=heavy_processes,
+    ram_config=ram_config,
     log_level="INFO",
 )
 
@@ -195,12 +201,14 @@ def when_paused():
 def when_resumed():
     print("💻 Back to work! Scripts resumed.")
 
+callbacks = Callbacks(
+    on_pause=when_paused,
+    on_resume=when_resumed,
+)
+
 app = FortScript(
     config_path="fortscript.yaml",
-    callbacks=Callbacks(
-        on_pause=when_paused,
-        on_resume=when_resumed,
-    )
+    callbacks=callbacks,
 )
 
 app.run()
@@ -284,22 +292,22 @@ my_project/
 
 ```python
 import os
-from fortscript import FortScript, GAMES
+from fortscript import FortScript, GAMES, RamConfig, Callbacks
 
 # Project paths
 base_dir = os.path.dirname(os.path.abspath(__file__))
 bot_path = os.path.join(base_dir, "discord_bot", "main.py")
 api_path = os.path.join(base_dir, "local_api", "package.json")
 
 # Projects to manage
-my_projects = [
+projects = [
     {"name": "Discord Bot", "path": bot_path},
     {"name": "Local API", "path": api_path},
 ]
 
 # Combining the default game list with custom processes
 # GAMES already includes GTA, Valorant, CS2, LOL, Fortnite, etc.
-my_heavy_processes = GAMES + [
+heavy_processes = GAMES + [
     {"name": "Video Editor", "process": "premiere"},
     {"name": "C++ Compiler", "process": "cl"}
 ]
@@ -314,15 +322,20 @@ def on_resume():
     print("💻 WORK MODE - Resuming your scripts...")
     print("=" * 50)
 
+# Configuration
+ram_config = RamConfig(threshold=85, safe=75)
+
+callbacks = Callbacks(
+    on_pause=on_pause,
+    on_resume=on_resume,
+)
+
 # Initialize FortScript
 app = FortScript(
-    projects=my_projects,
-    heavy_process=my_heavy_processes,
-    ram_config=RamConfig(threshold=85, safe=75),
-    callbacks=Callbacks(
-        on_pause=on_pause,
-        on_resume=on_resume,
-    ),
+    projects=projects,
+    heavy_process=heavy_processes,
+    ram_config=ram_config,
+    callbacks=callbacks,
 )
 
 if __name__ == "__main__":

README_ptBR.md

@@ -154,16 +154,22 @@ Você pode passar todas as configurações diretamente no código Python, sem pr
 ```python
 from fortscript import FortScript, RamConfig
 
+projects = [
+    {"name": "Meu Bot", "path": "./bot/main.py"},
+    {"name": "API Node", "path": "./api/package.json"},
+]
+
+heavy_processes = [
+    {"name": "GTA V", "process": "gta5"},
+    {"name": "OBS Studio", "process": "obs64"},
+]
+
+ram_config = RamConfig(threshold=90, safe=80)
+
 app = FortScript(
-    projects=[
-        {"name": "Meu Bot", "path": "./bot/main.py"},
-        {"name": "API Node", "path": "./api/package.json"},
-    ],
-    heavy_process=[
-        {"name": "GTA V", "process": "gta5"},
-        {"name": "OBS Studio", "process": "obs64"},
-    ],
-    ram_config=RamConfig(threshold=90, safe=80),
+    projects=projects,
+    heavy_process=heavy_processes,
+    ram_config=ram_config,
     log_level="INFO",
 )
 
@@ -213,12 +219,14 @@ def quando_retomar():
     print("💻 Voltando ao trabalho! Scripts retomados.")
     # Você pode: reconectar serviços, logar retorno, etc.
 
+callbacks = Callbacks(
+    on_pause=quando_pausar,
+    on_resume=quando_retomar,
+)
+
 app = FortScript(
     config_path="fortscript.yaml",
-    callbacks=Callbacks(
-        on_pause=quando_pausar,    # Função executada ao pausar
-        on_resume=quando_retomar,  # Função executada ao retomar
-    )
+    callbacks=callbacks,
 )
 
 app.run()
@@ -302,22 +310,22 @@ meu_projeto/
 
 ```python
 import os
-from fortscript import FortScript, GAMES
+from fortscript import FortScript, GAMES, RamConfig, Callbacks
 
 # Caminhos dos projetos (usando os.path para compatibilidade)
 base_dir = os.path.dirname(os.path.abspath(__file__))
 bot_path = os.path.join(base_dir, "bot_discord", "main.py")
 api_path = os.path.join(base_dir, "api_local", "package.json")
 
 # Lista de projetos para gerenciar
-meus_projetos = [
+projects = [
     {"name": "Bot Discord", "path": bot_path},
     {"name": "API Local", "path": api_path},
 ]
 
 # Combinando a lista de jogos padrão com processos personalizados
 # GAMES já inclui GTA, Valorant, CS2, LOL, Fortnite, etc.
-meus_processos_pesados = GAMES + [
+heavy_processes = GAMES + [
     {"name": "Editor De Vídeo", "process": "premiere"},
     {"name": "Compilador C++", "process": "cl"}
 ]
@@ -333,15 +341,20 @@ def ao_retomar():
     print("💻 MODO TRABALHO - Retomando seus scripts...")
     print("=" * 50)
 
+# Configurações
+ram_config = RamConfig(threshold=85, safe=75)
+
+callbacks = Callbacks(
+    on_pause=ao_pausar,
+    on_resume=ao_retomar,
+)
+
 # Inicializa o FortScript
 app = FortScript(
-    projects=meus_projetos,
-    heavy_process=meus_processos_pesados,
-    ram_config=RamConfig(threshold=85, safe=75),
-    callbacks=Callbacks(
-        on_pause=ao_pausar,
-        on_resume=ao_retomar,
-    ),
+    projects=projects,
+    heavy_process=heavy_processes,
+    ram_config=ram_config,
+    callbacks=callbacks,
 )
 
 if __name__ == "__main__":

src/fortscript/cookbook/project_with_arguments/main.py

@@ -12,13 +12,13 @@
 
 # Configuration for a typical developer development stack
 # These projects will be started automatically when system resources are stable
-development_projects = [
+projects = [
     {'name': 'API Gateway Simulator', 'path': backend_path}
 ]
 
 # Define heavy applications that should pause our dev stack
 # (e.g., when you want to play a game or render a video)
-productivity_blockers = [
+heavy_processes = [
     {'name': 'Chrome (Heavy Usage)', 'process': 'chrome.exe'},
     {'name': 'High-End Game', 'process': 'cyberpunk2077.exe'},
     {'name': 'Video Editor', 'process': 'premiere.exe'},
@@ -33,20 +33,24 @@ def on_resume():
     print('>>> [Event] System stable. Returning to development mode...')
 
 
-ram = RamConfig(
+# RAM configuration with hysteresis to prevent constant toggling
+ram_config = RamConfig(
     threshold=90,  # Pause if RAM usage exceeds 90%
-    safe=80,  # Resume only when RAM falls below 80% (Hysteresis)
+    safe=80,  # Resume only when RAM falls below 80%
 )
 
-# Initialize FortScript with our custom configuration and events
+# Callback functions for system events
+callbacks = Callbacks(
+    on_pause=on_pause,
+    on_resume=on_resume,
+)
+
+# Initialize FortScript with our custom configuration
 app = FortScript(
-    projects=development_projects,
-    heavy_process=productivity_blockers,
-    ram_config=ram,
-    callbacks=Callbacks(
-        on_pause=on_pause,
-        on_resume=on_resume,
-    ),
+    projects=projects,
+    heavy_process=heavy_processes,
+    ram_config=ram_config,
+    callbacks=callbacks,
     log_level='DEBUG',  # Show detailed logs for debugging
 )
 

src/fortscript/cookbook/project_with_games_list/main.py

@@ -18,11 +18,12 @@
 backend_path = os.path.join(base_dir, 'backend_simulator.py')
 
 # Configuration for a typical developer development stack
-development_projects = [
+projects = [
     {'name': 'Backend API Simulator', 'path': backend_path}
 ]
 
 
+# Callback functions for game detection events
 def on_pause():
     print('>>> [Event] Game detected! Development stack PAUSED.')
 
@@ -31,16 +32,26 @@ def on_resume():
     print('>>> [Event] No games running. Resuming development stack...')
 
 
+# RAM configuration with hysteresis to prevent constant toggling
+ram_config = RamConfig(
+    threshold=95,  # Pause if RAM usage exceeds 95%
+    safe=85,       # Resume only when RAM falls below 85%
+)
+
+# Callback configuration
+callbacks = Callbacks(
+    on_pause=on_pause,
+    on_resume=on_resume,
+)
+
+
 # Initialize FortScript utilizing the imported GAMES list
 # This demonstrates how to use the built-in list of heavy processes
 app = FortScript(
-    projects=development_projects,
+    projects=projects,
     heavy_process=GAMES,  # Using the imported list directly
-    ram_config=RamConfig(threshold=95, safe=85),
-    callbacks=Callbacks(
-        on_pause=on_pause,
-        on_resume=on_resume,
-    ),
+    ram_config=ram_config,
+    callbacks=callbacks,
     log_level='DEBUG',
 )
 

src/fortscript/cookbook/project_with_yaml_file/main.py

@@ -21,10 +21,16 @@ def welcome_back():
     print('✅ [System Alert] Resources cleared. Overlays are live again!')
 
 
+# Callback configuration
+callbacks = Callbacks(
+    on_pause=alert_system,
+    on_resume=welcome_back,
+)
+
 # Initialize FortScript using the external YAML file and events
 app = FortScript(
     config_path=config_path,
-    callbacks=Callbacks(on_pause=alert_system, on_resume=welcome_back),
+    callbacks=callbacks,
 )