Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yashsinghcodes/wik
wik is use to get information about anything on the shell using Wikipedia.
https://github.com/yashsinghcodes/wik
cli information python python3 wikipedia
Last synced: 6 days ago
JSON representation
wik is use to get information about anything on the shell using Wikipedia.
- Host: GitHub
- URL: https://github.com/yashsinghcodes/wik
- Owner: yashsinghcodes
- License: mit
- Created: 2021-06-16T15:55:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-25T14:44:12.000Z (8 months ago)
- Last Synced: 2025-01-12T12:11:16.513Z (13 days ago)
- Topics: cli, information, python, python3, wikipedia
- Language: Python
- Homepage: https://pypi.org/project/wik/
- Size: 207 KB
- Stars: 615
- Watchers: 9
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - yashsinghcodes/wik - wik is use to get information about anything on the shell using Wikipedia. (Python)
- project-awesome - yashsinghcodes/wik - wik is use to get information about anything on the shell using Wikipedia. (Python)
README
# WIK
wik is a tool to view wikipedia pages from your terminal.
It also let you search for any wikipedia up to date article on one query from your terminal.
### \[[Installation](#installation)] \[[Options](#options)] \[[Examples](#example)] \[[Contribution](#contribution)]
## Requirements
- Python3
- beautifulsoup4
## Installation
#### Linux
##### From Source
```bash
sudo pip3 install beautifulsoup4 flit_core
git clone https://github.com/yashsinghcodes/wik.git
cd wik
sudo pip3 install .
```
##### PYPI
```bash
sudo pip3 install wik
```
#### Windows
##### From Source
```
pip install beautifulsoup4 flit_core
git clone https://github.com/yashsinghcodes/wik.git
cd wik
pip install .
```
>Note: Windows users should have added python to there environment variable
##### PYPI
```
pip install wik
```
## Options
Using wik is acutally really simple.
```
usage: wik [-h] [-s SEARCH] [-i INFO] [-q QUICK] [-l LANG] [-x]
optional arguments:
-h, --help show this help message and exit
-s SEARCH, --search SEARCH
Search any topic
-i INFO, --info INFO Get info on any topic
-q QUICK, --quick QUICK
Get the summary on any topic
-l LANG, --lang LANG Get info in your native language (default english)
-x, --rand Get random Wikipedia article
```
## Example
```bash
$ wik -i Linux
```
```bash
$ wik -q Linux
```
```
$ wik -i Linux -l br
```
## Contribution
You can contribute to the project by opening a issue if you face any or making a pull
requests, if you think you can fix somthing or make improvment on the code. If you have some
ideas related to the project you can [contact me](https://yashwastaken.xyz/contact).