Metadata-Version: 2.4
Name: mush-wikis-scraper
Version: 1.0.2
Summary: Scraper for http://mushpedia.com/, http://twin.tithom.fr/mush/, https://cmnemoi.github.io/archive_aide_aux_bolets/ and QA Mush forum threads.
Project-URL: Bug Tracker, https://github.com/cmnemoi/mush_wikis_scraper/issues
Project-URL: Changelog, https://github.com/cmnemoi/mush_wikis_scraper/blob/main/CHANGELOG.md
Project-URL: Homepage, https://github.com/cmnemoi/mush_wikis_scraper
Project-URL: Repository, https://github.com/cmnemoi/mush_wikis_scraper
Author-email: Charles-Meldhine Madi Mnemoi <charlesmeldhine.madimnemoi@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: <3.14,>=3.10
Requires-Dist: beautifulsoup4>=4.13.4
Requires-Dist: httpx>=0.28.1
Requires-Dist: markdownify>=1.1.0
Requires-Dist: tqdm>=4.67.1
Requires-Dist: trafilatura[all]>=2.0.0
Requires-Dist: typer>=0.16.0
Description-Content-Type: text/markdown

# Mush wikis scraper

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

Scraper for http://mushpedia.com/, http://twin.tithom.fr/mush/, https://cmnemoi.github.io/archive_aide_aux_bolets/ and QA Mush forum threads.

# 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/mush_wikis_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).