semvec/pypi-packages huggingface dataset:
hyprtiler 0.2.2
A utility tool for managing windows in the Hyprland compositor environment.
License: MIT
Requires Python: >=3.13

<!-- markdownlint-disable -->

# hyprtiler 🏗️

hyprtiler is a Python application designed to manage and automatize experience with windows in [Hyprland](https://hyprland.org/) Wayland Compositor. It provides advanced tiling, floating, and automation features to streamline your workflow with [Hyprland](https://hyprland.org/) writing rules directly in **hyprland.conf** file.

<div align="center">
  <span>
    <img alt="PyPI - Version" src="https://img.shields.io/pypi/v/hyprtiler">
    <img alt="AUR Version" src="https://img.shields.io/aur/version/hyprtiler">
    <img alt="Python Version from PEP 621 TOML" src="https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fantrax2024%2Fhyprtiler%2Frefs%2Fheads%2Fmain%2Fpyproject.toml">
    <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/antrax2024/hyprtiler">
    <img alt="GitHub License" src="https://img.shields.io/github/license/antrax2024/hyprtiler">
  </span>
</div>

## Features ✨

- Window rules for hyprland automation
- Lightweight and fast

## Requirements 📋

- Python 3.12+
- Linux (tested on major distributions)
- Hyprland or compatible window manager running

## Installation ⚙️

1. Create and activate a python Virtual Environment in any directory:

   ```bash
   cd any-dir/
   python -m venv .venv
   source .venv/bin/activate.fish # if you use fish
   source .venv/bin/activate # if you use bash or zsh
   ```

2. Install application:
   ```bash
   pip install hyprtiler
   ```

```bash
hyprtiler
```

## Command-line Arguments

The `hyprtiler` application provides the following command-line arguments:

- `-h`, `--help` (optional):

  - Type: string
  - Description: Show the help.

- `-r`, `--rule` (optional):

  - Type: string
  - Description: Rule that will be applied to the window. Default is `float`.

- `-c`, `--window-class` (required):

  - Type: string
  - Description: Regular expression of the window class.

- `-v`, `--version`:
  - Action: Shows the version number and exits.

### Example Usage

```sh
hyprtiler -r float -c 'alacritty'
```

This command applies the `float` rule to windows matching the class `alacritty`.

## Contributing 🤝

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

## License 📜

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.