Metadata-Version: 2.4
Name: mc-wiki-scraper
Version: 0.1.3
Summary: Scrape and analyze articles from minecraft.wiki
Project-URL: Source, https://github.com/orowicki/wiki-scraper
Author-email: Oskar Rowicki <oskar.rowicki@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Oskar Rowicki
        
        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.
        
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: beautifulsoup4>=4.13.0
Requires-Dist: matplotlib>=3.10.8
Requires-Dist: numpy>=2.4.1
Requires-Dist: pandas>=3.0.0
Requires-Dist: regex>=2026.1.15
Requires-Dist: requests>=2.31
Requires-Dist: wordfreq>=3.1.1
Provides-Extra: test
Requires-Dist: pytest>=9.0.2; extra == 'test'
Description-Content-Type: text/markdown

# MC Wiki Scraper

![Python](https://img.shields.io/pypi/pyversions/mc-wiki-scraper)
[![PyPI](https://img.shields.io/pypi/v/mc-wiki-scraper)](https://pypi.org/project/mc-wiki-scraper/)
[![Tests](https://img.shields.io/github/actions/workflow/status/orowicki/wiki-scraper/tests)](https://github.com/orowicki/wiki-scraper/actions)
![Lint](https://img.shields.io/badge/lint-ruff-green)

Scrape and analyze articles from [minecraft.wiki](https://minecraft.wiki/)

---

## Features

- **Summary** – Get the first paragraph of an article.  
- **Table Extraction** – Extract tables and save them as CSV.  
- **Count Words** – Count words in an article and aggregate results in `word-counts.json`.  
- **Analyze Relative Word Frequency** – Compare word frequencies across articles or the whole language.  
- **Auto Count Words** – Traverse links automatically and count words in articles.  

---

## Usage

Show help:

```bash
mc-wiki-scraper -h
```

Example:

```bash
mc-wiki-scraper summary 'iron ingot'
```

---

## Installation

Requires **Python 3.11+**. Install to a virtual environment (recommended):

```bash
python -m venv .venv  
source .venv/bin/activate  
pip install mc-wiki-scraper
```

---

## Development

Clone the repository and install with test dependencies:
```bash
pip install -e '.[test]'  
pytest
```
