Metadata-Version: 2.4
Name: wik
Version: 2.0.1
Summary: wik is used to get information about anything on the shell using Wikipedia
Author-email: Yash Singh <mailmeatyashsingh@gmail.com>
Requires-Python: >=3.0
Description-Content-Type: text/markdown
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
License-File: LICENSE
Requires-Dist: beautifulsoup4
Requires-Dist: requests
Requires-Dist: flit ; extra == "dev"
Project-URL: Home, https://github.com/yashsinghcodes/wik
Provides-Extra: dev

# WIK
WIK is a command-line tool to view Wikipedia pages from your terminal.
It also lets you search Wikipedia articles with a single query.

<div align="center">

  ### \[[Installation](#installation)] \[[Options](#options)] \[[Examples](#example)] \[[Contribution](#contribution)]

</div>

## Requirements
- Python3
- beautifulsoup4

## Installation

### Linux/macOS

#### From source
```bash
python3 -m pip install beautifulsoup4 flit_core
git clone https://github.com/yashsinghcodes/wik.git
cd wik
python3 -m pip install .
```

#### PyPI
```bash
python3 -m pip install wik
```

### Windows

#### From source
```bash
python -m pip install beautifulsoup4 flit_core
git clone https://github.com/yashsinghcodes/wik.git
cd wik
python -m pip install .
```
>Note: Windows users should add Python to their environment variables.

#### PyPI
```bash
python -m pip install wik
```
or
```bash
pip install wik
```

## Options
Using WIK is simple.

```
usage: wik [-h] [-s SEARCH] [-i INFO] [-q QUICK] [-l LANG] [-x] [--no-cache]
           [--clear-cache]

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
  --no-cache            Disable on-disk cache for this run
  --clear-cache         Clear cached pages and exit
```

## Example

```bash
$ wik -i Linux
```
![example output](docs/img/carbon.png)

### Cache
WIK stores pages on disk so repeated queries are instant and can work offline. You can
disable caching per run or clear the cache:

```
wik --no-cache -i Linux
wik --clear-cache
```


## Contribution
You can contribute by opening an issue or making a pull request. If you have ideas or
feedback, you can [contact me](mailto:yash9vardhan@gmail.com).

