Skip to main content

PowerRules

latest-version latest-beta-version license

About

PowerRules allows you to define rules that automatically control the power state of your computer based on configurable conditions.

Rules are evaluated from top to bottom. The first matching rule executes its configured action.

Getting Started

Install with pip:

pip install powerrules

Create a policy file:

# yaml-language-server: $schema=https://raw.githubusercontent.com/LeoTN/PowerRules/main/assets/schema/powerrules_policy.schema.json

rules:
  - name: "Shutdown after nightly weekend backup"
    conditions:
      and:
        - process:
            name: "backup.exe"
            running: false
        - window:
            title: "Backup Completed"
            exists: true
        - datetime:
            between:
              start: "23"
              end: "1:30"
        - datetime:
            weekday: ["Saturday", "Sunday"]
    action:
      type: shutdown

Validate the policy:

pwru policy validate

Show configured rules:

pwru policy show

Evaluate the policy once:

pwru policy run --once

Run continuously:

pwru policy run

Use a different policy file with --policy or -p:

pwru policy run --policy my-policy.yaml

Features

Feature Description
Rule-based power management Define ordered rules with conditions and power actions
Process conditions Match rules based on whether a process is running
Time conditions Match time ranges and weekdays
Window conditions Match window titles
Logical conditions Combine conditions using and, or, and not
Power actions Shutdown, sleep, hibernate, and reboot
Continuous evaluation Evaluate policies repeatedly
First-match execution Only the first matching rule executes once per match

Supported Platforms

Platform Status
Windows 10/11 ✅
Linux ✅
macOS* ✅

* Hibernation is not supported on macOS.

Credits & License

  • Pydantic → configuration validation
  • PyYAML → YAML policy parsing
  • Typer → command-line interface
  • psutil → process information
  • PyWinCtl → window information
  • Inkscape → program used to design the logo

This repository is licensed under the MIT License.

Release files for powerrules 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for powerrules 0.1.1
File Size Uploaded
powerrules-0.1.1.tar.gz 13.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for powerrules 0.1.1
File Interpreter ABI Platform
powerrules-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 35.2 kB

Release files / powerrules-0.1.1.tar.gz

Download URL powerrules-0.1.1.tar.gz
Size 13.8 kB
Tags Source
SHA-256 checksum
How to use checksums
3e75b4b17eba2014975dc3273fe6b570fba13fc673a2adf94b27085d4e60d2ff
BLAKE2b-256 checksum
How to use checksums
a454621fb4ed1e4d1fb329204e8506c121d17e1f0677e27508ee21ffcf84571a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1022-azure

Release files / powerrules-0.1.1-py3-none-any.whl

Download URL powerrules-0.1.1-py3-none-any.whl
Size 21.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c1867425e191722cae77a8ae03180a2372b8d4abf31ece191e1fd539bffd2b2d
BLAKE2b-256 checksum
How to use checksums
8fd023aeafe97c084b8b0ff907af85ba146824c9c3c0e765e74313966d6a0399
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1022-azure
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page