Metadata-Version: 2.1
Name: wikipsy
Version: 1.2.5
Summary: Scrape wikipedia to get to psychology/philosophy
Author-email: Jayden Qi <jaydeniqv2@gmail.com>
License: MIT License
        
        Copyright (c) [2023] [Jayden Qi]
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/JayAndJef/wikipedia-scraper
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.31.0
Requires-Dist: typer[all]>=0.9.0
Requires-Dist: beautifulsoup4>=4.12.2
Requires-Dist: graphviz>=0.20.1
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: bumpver; extra == "dev"
Requires-Dist: pytest; extra == "dev"

# WikiPsy
[![PyPI version](https://badge.fury.io/py/wikipsy.svg)](https://badge.fury.io/py/wikipsy)

Provides multiple functionalities for scraping wikipedia, the centerpoint being getting to psychology or philosophy.

## Installation

Use pip:
```sh
pip install wikipsy
```

And then run 
```
❯ wikipsy --help
                                                                                                                                                                                          
 Usage: wikipsy [OPTIONS] COMMAND [ARGS]...                                                                                                                           
                                                                                                                                                                                          
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.                                                                                                                │
│ --show-completion             Show completion for the current shell, to copy it or customize the installation.                                                                         │
│ --help                        Show this message and exit.                                                                                                                              │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ graph-multiple  Given multiple wikipedia pages, scrapes and generated a directed graphviz source file showing the those articles' path to Psychology. For ease of use, direct the      │
│                 output of this command into a graphviz dot file.                                                                                                                       │
│ psychology      Scrapes the leading hyperlink of Wikipedia pages recursively until the page "Psychology" is reached.                                                                   │
│ scrape          Scrape a Wikipedia page for its hyperlinks. Ignores the topmost note section and links in parenthetical sentences.                                                     │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

```
