https://github.com/sukhbinder/winzy-visual-notify

Notify using visual artefacts like clippy and other things.
https://github.com/sukhbinder/winzy-visual-notify

Last synced: 2 months ago
JSON representation

Notify using visual artefacts like clippy and other things.

• Host: GitHub
• URL: https://github.com/sukhbinder/winzy-visual-notify
• Owner: sukhbinder
• License: apache-2.0
• Created: 2024-11-27T15:16:51.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-27T16:02:02.000Z (2 months ago)
• Last Synced: 2024-11-27T16:28:05.976Z (2 months ago)
• Language: Python
• Size: 180 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# winzy-visual-notify

[![PyPI](https://img.shields.io/pypi/v/winzy-visual-notify.svg)](https://pypi.org/project/winzy-visual-notify/)

[![Changelog](https://img.shields.io/github/v/release/sukhbinder/winzy-visual-notify?include_prereleases&label=changelog)](https://github.com/sukhbinder/winzy-visual-notify/releases)

[![Tests](https://github.com/sukhbinder/winzy-visual-notify/workflows/Test/badge.svg)](https://github.com/sukhbinder/winzy-visual-notify/actions?query=workflow%3ATest)

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/sukhbinder/winzy-visual-notify/blob/main/LICENSE)

Notify using visual artefacts like clippy and other things.

## Installation

First configure to install Winzy [to use Winzy](https://github.com/sukhbinder/winzy).

which means.

```bash

pip install winzy

```

Then install this plugin in the same environment as your Winzy application.

```bash

winzy install winzy-visual-notify

```

## Usage

```bash

usage: winzy tell [-h] [-t [TEXT ...]]

                  [-c {dog,dog2,watermellon,bee,ghost,hen,man,pear,purple,random}]

Notify using visual artefacts like clippy and other things.

optional arguments:

  -h, --help            show this help message and exit

  -t [TEXT ...], --text [TEXT ...]

                        Text to display

  -c {dog,dog2,watermellon,bee,ghost,hen,man,pear,purple,random}, --character {dog,dog2,watermellon,bee,ghost,hen,man,pear,purple,random}

                        Name of Character to display

```

## Demo

![winzy tell ](https://raw.githubusercontent.com/sukhbinder/winzy-visual-notify/refs/heads/main/winzy-visual-notify-demo.gif)

## Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

```bash

cd winzy-visual-notify

python -m venv venv

source venv/bin/activate

```

Now install the dependencies and test dependencies:

```bash

pip install -e '.[test]'

```

To run the tests:

```bash

python -m pytest

```