fixed pylint errors

Author: ipsavitsky

Diff for: README.md

@@ -0,0 +1,15 @@
+# Wiki cli searcher
+
+Right now it is only able to search in Wikipedia. Techichally can search in every MediaWiki website (api to be added)
+
+Works by requesting generated page contents, filtering them, converting them to Markdown and then displaying them.
+
+## Usage
+
+```bash
+python3 wiki <keyword>
+```
+
+## Example
+
+![tool screenshot](imgs/screenshot.png)

Diff for: wiki_search/__main__.py

@@ -1,12 +1,15 @@
 import argparse
+import logging as log
+import sys
+
 from bs4 import BeautifulSoup
 from markdownify import MarkdownConverter
 from rich.console import Console
 from rich.markdown import Markdown
-from soup_filters import filter_soup
-from wikipedia import NoArticleFound, fetch_wiki_data
-from options import Options
-import logging as log
+
+from .options import Options
+from .soup_filters import filter_soup
+from .wikipedia import NoArticleFound, fetch_wiki_data
 
 log.basicConfig(level=log.INFO)
 
@@ -26,7 +29,7 @@
     page_info = fetch_wiki_data(options, args.keyword)
 except NoArticleFound as e:
     console.print(f'No article "{e.fprompt}" found')
-    exit(1)
+    sys.exit(1)
 
 soup = BeautifulSoup(page_info["text"]["*"], "html.parser")
 

Diff for: wiki_search/options.py

@@ -1,7 +1,10 @@
+"""Wikipedia search options module"""
 from dataclasses import dataclass
 
 
 @dataclass
 class Options:
+    """Wikipedia search options class"""
+
     class_prefix: str = "en"
     skip_tables: bool = True

Diff for: wiki_search/soup_filters.py

@@ -1,8 +1,21 @@
+"""A bs4 filtering module."""
 from bs4 import BeautifulSoup
-from options import Options
+
+from .options import Options
 
 
 def filter_soup(opts: Options, title: str, soup: BeautifulSoup) -> BeautifulSoup:
+    """Apply filtering to the soup.
+
+    :param opts: Request options.
+    :type opts: Options
+    :param title: Title of the article.
+    :type title: str
+    :param soup: BeautifoulSoup to filter.
+    :type soup: BeautifulSoup
+    :return: Filtered BeautifulSoup.
+    :rtype: BeautifulSoup
+    """
     body = soup.find("div", class_="mw-parser-output")
     for tag in body.find_all("table", class_="infobox"):
         tag.decompose()

Diff for: wiki_search/wikipedia.py

@@ -1,13 +1,27 @@
+"""Wikipedia api request module."""
 import requests
-from options import Options
+
+from .options import Options
 
 
 class NoArticleFound(Exception):
+    """No found article exception class."""
+
     def __init__(self, failed_prompt: str):
         self.fprompt = failed_prompt
 
 
 def fetch_wiki_data(opts: Options, prompt: str) -> str:
+    """Fetch data html from Wiki api
+
+    :param opts: Request options.
+    :type opts: Options
+    :param prompt: Prompt to search at Wikipedia.
+    :type prompt: str
+    :raises NoArticleFound: Raised if no article found at Wikipedia.
+    :return: String of HTML returned by API
+    :rtype: str
+    """
     url = f"https://{opts.class_prefix}.wikipedia.org/w/api.php"
     params = {
         "action": "parse",