Contributors Stargazers Issues MIT license GitHub Workflow Status Lines of code


Logo

WIKI-TUI

A simple and easy to use Wikipedia Text User Interface

Preview

Features

wiki-tui currently has these features: - Browse through Wikipedia (Set the language by changing the url in the config) - Uses webscraping and a custom view to display wikipedia articles in the terminal - Use links to open other articles

These features are planned: - View and interact with more elements of wikipedia articles (like tables, images, etc.)

How it looks

image image image
Note: These Screenshots were taken on alacritty (MacOS) with the spaceduck theme and the Sauce Code Pro font

Installation

Currently, you can install wiki-tui only by compiling it manually. Just clone the repository and compile the stable branch.

Configuration

Location of the config file

MacOS and Linux

$HOME/.config/wiki-tui/config.ini

Windows

C:\Users\{USERNAME}\wiki-tui\config.ini

Settings

Api

ini ; this is the url of wikipedia, it can be changed to change the language of wikipedia BASE_URL = "https://en.wikipedia.org/"

Theme

The settings here are all colors and can be set by either the name of the color or a hex string (valid formats are: #ffffff, #fff). If your color wasn't applied, check the logs to find out why.

The actual colors displayed in your terminal can change depending on your terminal settings ini ; color used for View backgrounds background = white ; color used for the title text title = red ; color used for highlighting text highlight = red ; color used for highlighting inactive text highlight_inactive = blue ; color used for highlighted text highlight_text = white ; color used for the text text = black ; color used for a search match in the results view search_match = red

Logging

ini ; can be either true or false. enables/disables logging enabled = true ; location of the file where the log will be written to log_dir = "wiki_tui.log" ; log level to be used, can be Debug, Info, Warn, Error log_level = Info

Contributing

Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Switch to the experimental branch
  3. Commit your Changes
  4. Push to the branch
  5. Open a Pull Request

Logging

As of 0.3.2 you can no longer configure the logger with a .yml file

Acknowledgements