Skip to content

Latest commit

 

History

History
100 lines (73 loc) · 4.67 KB

README.md

File metadata and controls

100 lines (73 loc) · 4.67 KB

doge

PyPI - Version PyPI - Downloads PyPI - Python Version Ruff GitHub License

wow screenshot

doge is a simple motd script based on the slightly stupid but very funny doge meme. It prints random grammatically incorrect statements that are sometimes based on things from your computer.

If you have pipx (you should!), you can try out doge without installing it permanently.
Just type pipx run doge in your terminal to see if you enjoy it. 🐶
If you do, pipx install doge to keep it around! 👍

Features

  • Randomly placed and colored random strings, complete with broken english.
  • Awesome Shibe 😎 in the terminal.
  • Fetching of system data, such as hostname, running processes, current user and $EDITOR.
  • If you have 🌈 lolcat, you can do this gem:
    while true; do doge | lolcat -a -d 100 -s 100 -p 1; done (thx hom3chuk)
  • stdin support: ls /usr/bin | doge will doge-print some of the executables found in /usr/bin. wow. There are also multiple command line switches that control filtering and statistical frequency of words. See doge -h, wow.
    • To use all dictionary words that start or end with "dog", try:
      egrep '(^dog|dog$)' /usr/share/dict/words | fgrep -v "'s" | doge

Notes

You need a terminal that supports 256 colors running on a system that supports unicode.

The terminal Shibe was created with hax0r Gimp skills and img2xterm.

Installation

There are several options for installing and running a Python CLI application such as doge.

Python-Based Install (Recommended)

  • pipx install doge -- this is the recommended method, but you need pipx installed and configured.
    • pipx is usually the best way to install and run Python-based applications from PyPI, so if you don't yet have it, you should! 👍
    • To install newer versions, run pipx upgrade doge or pipx upgrade-all.
  • Make a Python zipapp with pex or shiv, and put it in your $PATH, for example:
    • shiv doge -c doge -o ~/bin/doge
    • pex doge -c doge -o ~/bin/doge
  • Install with pip, see Brett Cannon's quick-and-dirty guide on how to install packages for Python for more information. TLDR; basically use your preferred Python and run:
    python3 -m pip install doge

Then, just add a call to doge at the bottom of your shell rc file.

If you don't want to install doge with the options above for whatever reason, there is a proper pyproject.toml included, so inside a virtual environment, python -m pip install -e . should work just fine.

Package Managers And Linux Distributions

Your package manager or Linux distribution might carry a downstream doge package.

If you choose this option, and experience any installation problems, then please report them to your downstream package maintainer.

Packaging status

Please note that it might take some time for downstream packages to catch up with PyPI. The recommended installation with pipx will always give you the latest version.