Metadata-Version: 2.3
Name: dispcat
Version: 0.1.1
Summary: A CLI tool to display random cat images in separate windows on your screen, with optional frameless mode.
Author: Paul Chupot
Author-email: paul.chupot@edu.escp.eu
Requires-Python: >=3.10
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: click (>=8.2.1,<9.0.0)
Requires-Dist: matplotlib (>=3.10.6,<4.0.0)
Requires-Dist: pillow (>=11.3.0,<12.0.0)
Requires-Dist: pyqt5 (>=5.15.11,<6.0.0)
Requires-Dist: requests (>=2.32.5,<3.0.0)
Description-Content-Type: text/markdown

# dispcat

![](https://www.catbehaviourist.com/wp-content/uploads/2015/07/amazing-black-cats_1024-1.jpg)

**dispcat** is a simple CLI tool that displays random cat images in separate windows on your screen. You can choose how many cats to display, how many "waves" of cats to see, and optionally hide the OS window toolbar for a frameless experience.

## Features

- Display one or more random cat images in separate windows
- Show multiple "waves" of cats, each wave appearing after the previous closes
- Option to hide the OS window toolbar (frameless mode)
- Fast and easy to use from the command line

## Installation

You need Python 3.10 or higher.

Install using [Poetry](https://python-poetry.org/):

```sh
poetry install
```

Or install directly with pip:

```sh
pip install dispcat
```

## Usage

Run the following command to display a cat:

```sh
dispcat
```

To display multiple cats:

```sh
dispcat --count 5
```

To display cats in frameless windows:

```sh
dispcat --frameless
```

To display several waves of cats (each wave appears after the previous closes):

```sh
dispcat --waves 3
```

You can combine options:

```sh
dispcat --count 4 --waves 2 --frameless
```

## Options

| Option         | Description                                      | Default |
|----------------|--------------------------------------------------|---------|
| `--count`      | Number of cat images to display per wave         | 5       |
| `--waves`      | Number of waves of cats to display               | 1       |
| `--frameless`  | Hide OS window toolbar (frameless mode)          | False   |


