Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

About

Define rules to control your computer's power state 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:
  # Shut down when no backup process is running, a matching backup window is open, and the current time is between 23:00 and 01:30
  - name: "Shutdown after nightly backup"
    enabled: true
    conditions:
      and:
        - process:
            name: "backup.exe"
            exists: false
        - window:
            title: "Backup Nr. [0-9]+ Completed"
            exists: true
            match:
              type: regex
        - datetime:
            between:
              start: "23"
              end: "1:30"
    action:
      type: shutdown

Evaluate the policy once. Use --dry-run to see what would happen:

pwru policy run --once --policy my-policy.yaml --dry-run

Features

Process & Window Matching

Match rules based on processes and window titles.

# Match if process "firefox.exe" is running
- process:
    name: "firefox.exe"
    exists: true

# Match if window with exact title "Firefox" exists
- window:
    title: "Firefox"
    exists: true

Regex Matching

Match process names and window titles using regular expressions with full-string matching.

# Match if process name ends with "firefox"
- process:
    name: ".*firefox.exe"
    match:
      type: regex
      # This is the default behavior
      case_sensitive: true

# Match if window title starts with "firefox" (case insensitive)
- window:
    title: "Firefox.*"
    match:
      type: regex
      case_sensitive: false

Time-based Conditions

Match specific dates, time ranges, weekdays and months. If several of between, weekday and month are configured, all of them must match. The end of a range is always exclusive.

# Match every day from 23:00 until 1:30 the next morning
- datetime:
    between:
      start: "23"
      end: "1:30"

# Match on Mondays and Fridays
- datetime:
    weekday:
      - "Monday"
      - "Friday"

# Match in June, July and August
- datetime:
    month:
      - "June"
      - "July"
      - "August"

# Match on the whole days 2026-08-21 and 2026-08-22 (the end date 2026-08-23 is not included)
- datetime:
    between:
      start: "2026-08-21"
      end: "2026-08-23"

# Match from 2026-08-21 18:00 until 2026-08-23 6:00
- datetime:
    between:
      start: "2026-08-21 18:00"
      end: "2026-08-23 6:00"

# Match on Saturdays and Sundays from 2026-08-21 until the end of 2026
- datetime:
    between:
      start: "2026-08-21"
      end: "2027-01-01"
    weekday:
      - "Saturday"
      - "Sunday"

# Match on Saturday and Sunday nights in December from 22:00 until 6:00 the next morning
- datetime:
    between:
      start: "22"
      end: "6"
    weekday:
      - "Saturday"
      - "Sunday"
    month:
      - "December"

start and end must be of the same kind: both times, both dates or both dates with a time. All values use the local time of the computer, timezones are not supported.

If a time range crosses midnight, weekday and month refer to the day on which the range starts. For dates, they refer to the current day.

Logical Conditions

Combine multiple conditions using and, or, and not.

# Match if (condition_1 OR condition_2) AND NOT condition_3
- and:
    - or:
        - condition_1: ...
        - condition_2: ...
    - not:
        condition_3: ...

Power Actions

Shutdown, sleep, hibernate, or reboot your computer.

# Shutdown on match
- action:
    type: shutdown

# Reboot on match
- action:
    type: reboot

Continuous Evaluation

Evaluate rules at a set interval. A matching rule is triggered only when it becomes the active match, avoiding repeated execution while the same rule remains matched.

pwru policy run

--stop-on-match can be used to stop the evaluation after the first match.

Supported Platforms

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

* Hibernation is not supported on macOS. Window conditions are unavailable for the prebuilt executable.

Credits & License

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

This repository is licensed under the MIT License.

Metadata

Release files for powerrules 0.5.0b2

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.5.0b2
File Size Uploaded
powerrules-0.5.0b2.tar.gz 28.3 kB Details

Built distribution (wheel)

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

Total release size: 66.3 kB

Release files / powerrules-0.5.0b2.tar.gz

Download URL powerrules-0.5.0b2.tar.gz
Size 28.3 kB
Tags Source
SHA-256 checksum
How to use checksums
d65f5ed694ee7dd87ec3bf74afe66f0a81eeccf6c9848fde4a0a2edfb6d2f507
BLAKE2b-256 checksum
How to use checksums
0513062d553aa19fb9896a6509fb3b0c3d730659c1e09275e7128c3ca50179a8
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.5.0b2-py3-none-any.whl

Download URL powerrules-0.5.0b2-py3-none-any.whl
Size 38.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3b60fbc7125db1f9ee7decf629ccce11e6b5cd426693fced27d352ea4dccb48a
BLAKE2b-256 checksum
How to use checksums
7092a5834291999b93e262b397711ce86127162852bb03ce7f29553888d5023d
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 history Release notifications | RSS feed

0.5.0

2 release files

This release

0.5.0b2 This release

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

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