Skip to content

A minimal desktop companion that tells you jokes routinely. For windows/Linux/Mac. Built with python

License

Notifications You must be signed in to change notification settings

Ndeh-007/RoastMe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Humor Me

A customizable joke teller. Jokes are gotten from JokesAPI. Insults are gotten from EvilInsults Creates a floating window that shows content (jokes/insults)

docs/img.png

For Devs

To build locally

  1. have python installed
  2. clone repo and create virtual environment
  3. install requirements
         pip install -r requirement.txt
  4. run application
        python app.py   
  5. To build deploy see here

Installation (Windows)

  • Download the current release from here
  • Extract to suitable location
  • Run the installer
  • There maybe an antivirus warning. Ignore.

Usage

Run the installed application. A bubble will appear at the top-right corner of your main desktop window. A settings menu will also be shown by default. Closing the settings menu will not terminate the application.

To terminate application, open the system tray, click on the application and select quit.

When a joke is told, the bubble will automatically hide after 1 min

Configuration

To open the settings window, right-click on the bubble and select settings

docs/img_1.png

  1. The fetch interval is the time between jokes told.
  2. language is what language you want the joke to come in
  3. Category offers the selected spools of jokes to be told
  4. Filter out certain kinds of jokes
  5. Joke type will ensure you either of the two. one must be selected. if none are selected, the application will default to both types
  6. you can decide to get jokes as well as insults. (the configuration works only for the jokes.)
  7. The console shows the progression.

About

A minimal desktop companion that tells you jokes routinely. For windows/Linux/Mac. Built with python

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Languages