Skip to main content

Knowledge

Project description

About

Zennin is a simple Python program that prints random quotes on the terminal. It adds a touch of inspiration or amusement to your daily console experience.

Usage

The program is designed to be integrated into your bashrc, zshrc or preferred shell configuration file. By doing so, every time you open a new terminal session, you'll be greeted with a random quote of your choice. It's similar to how many people use neofetch for displaying system information everytime a new terminal is opened.

Quote Book

The collection of quotes used by zennin is stored in a file known as the Quote Book. By default, the program looks for the quote book at $HOME/.config/zennin/quotebook.txt. If this file doesn't exist, zennin falls back to using a default quote book located at /etc/quotebook.txt.

Feel free to use the default quote book as a reference to create your own personalized collection. The syntax of the quote book is similar to Python docstrings, with three single quotes (''') used as delimiters for the beginning and the end of each quote.

'''
This is a Quote
'''

'''
This is another Quote

You can have empty lines inside the quote
'''

Customization

You have the freedom to populate the quote book with your own favorite quotes. Choose the quotes that resonate with you, whether they are inspirational, funny, or thought-provoking. Additionally, you can customize the justification style in which the quotes are printed in the terminal. Pick from left, right, or center justification based on your preference.

Installation

Arch linux

Install from AUR

From a clone

Zennin requires build and installer python modules to install.

To check if these modules are installed run this lines in a terminal.

python -c "import build" 2>/dev/null && \
  echo "python-build is installed" || \
  echo "python-build is NOT installed";
python -c "import installer" 2>/dev/null && \
  echo "python-installer is installed" || \
  echo "python-installer is NOT installed"

If this modules are not present, install them using pip or your system package manager

After doing this follow this instructions:

  • Clone this repository
  • Change to the created directory
  • Run sudo make install

Or copy this lines and run them in a terminal

git clone https://github.com/Erymer/zennin
cd zennin
sudo make install

Using Zennin

To use it as intended just include one of the following lines in the configuration file of your shell (bashrc, zshrc, etc).

zennin # Text in the center of the terminal
zennin --justify right # Text to the far right
zennin --justify left # Text to the far left

And thas it! Now everytime you open a new terminal you will be greeted with a quote.

To Do

  • More text color options.
  • Create an option to pick a different quote delimitator.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Zennin-1.0.0.tar.gz (18.3 kB view details)

Uploaded Source

Built Distribution

Zennin-1.0.0-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

Details for the file Zennin-1.0.0.tar.gz.

File metadata

  • Download URL: Zennin-1.0.0.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for Zennin-1.0.0.tar.gz
Algorithm Hash digest
SHA256 c4198ce5024832817bba6ac56586d61c6bcd35db5c099ed0924f7ca810b4b0f3
MD5 c4f743e669def4faf3cd63fa4e2bda20
BLAKE2b-256 58a203f8afa17c5d90a54cb2d557989aed3138bd7d78adc430d20b0cf5b515c4

See more details on using hashes here.

File details

Details for the file Zennin-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: Zennin-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 17.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for Zennin-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6776540f03052ca236c36d93cfcbe8349a45257f429e9f1ae8a625d1e2cad5af
MD5 2400d1826c93b8e573fd7b9e2e10682e
BLAKE2b-256 04465108f9e0ca8cdea4cff2589adf76c38c3cd259997c412ad2d171ece899ce

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page