Metadata-Version: 2.3
Name: mush-wikis-scraper
Version: 0.5.0
Summary: Scraper for http://mushpedia.com/ and http://twin.tithom.fr/mush/
Author-email: Charles-Meldhine Madi Mnemoi <charlesmeldhine.madimnemoi@gmail.com>
License: MIT
Requires-Python: <3.14,>=3.9
Requires-Dist: beautifulsoup4>=4.12.3
Requires-Dist: httpx>=0.27.2
Requires-Dist: markdownify>=0.13.1
Requires-Dist: requests>=2.32.3
Requires-Dist: typer>=0.13.0
Description-Content-Type: text/markdown

# Mush wikis scraper

[![Continous Integration](https://github.com/cmnemoi/mushpedia_scraper/actions/workflows/ci.yaml/badge.svg)](https://github.com/cmnemoi/mushpedia_scraper/actions/workflows/ci.yaml) 
[![Continous Delivery](https://github.com/cmnemoi/mushpedia_scraper/actions/workflows/publish_to_pypi.yaml/badge.svg)](https://github.com/cmnemoi/mushpedia_scraper/actions/workflows/publish_to_pypi.yaml)
[![codecov](https://codecov.io/gh/cmnemoi/mushpedia_scraper/graph/badge.svg?token=FLAARH38AG)](https://codecov.io/gh/cmnemoi/mushpedia_scraper)
[![PyPI version](https://badge.fury.io/py/mushpedia-scraper.svg)](https://badge.fury.io/py/mushpedia-scraper)

Scraper for http://mushpedia.com/ and http://twin.tithom.fr/mush/

# Usage

Install with `python -m pip install --user mush-wikis-scraper`

Then run `python mush-wikis-scrap` in your terminal. The package supports 3 formats: `html`, `text` and `markdown` with the `--format` option.

The result will be printed to the terminal. You can redirect it to a file with `python mush-wikis-scrap > output`.

# Contributing

You need to have `curl` and [`uv`](https://docs.astral.sh/uv/getting-started/installation/) installed on your system.

Then run the following command : `curl -sSL https://raw.githubusercontent.com/cmnemoi/mushpedia_scraper/main/clone-and-install | bash`

## Development

Run tests with `make test`.

# License

The source code of this repository is licensed under the [MIT License](LICENSE).