https://github.com/openzim/wikihow

WikiHow scraper
https://github.com/openzim/wikihow

scraper wikihow zim

Last synced: about 1 year ago
JSON representation

WikiHow scraper

• Host: GitHub
• URL: https://github.com/openzim/wikihow
• Owner: openzim
• License: gpl-3.0
• Created: 2021-07-21T15:11:04.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-11-01T21:03:55.000Z (over 1 year ago)
• Last Synced: 2025-04-06T08:01:45.744Z (about 1 year ago)
• Topics: scraper, wikihow, zim
• Language: Python
• Homepage: https://download.kiwix.org/zim/wikihow/
• Size: 368 KB
• Stars: 23
• Watchers: 7
• Forks: 4
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# wikiHow

`wikihow2zim` is an [OpenZIM](https://openzim.org) scraper to create offline versions of [wikiHow](https://www.wikihow.com) websites, in all its supported languages.

[![CodeFactor](https://www.codefactor.io/repository/github/openzim/wikihow/badge)](https://www.codefactor.io/repository/github/openzim/wikihow)

[![Docker](https://ghcr-badge.egpl.dev/openzim/wikihow/latest_tag?label=docker)](https://ghcr.io/openzim/wikihow)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

[![PyPI version shields.io](https://img.shields.io/pypi/v/wikihow2zim.svg)](https://pypi.org/project/wikihow2zim/)

## Usage

`wikihow2zim` works off a *language version* that you must provide via the `--language` argument. The list of supported languages is visible in the `--help` message.

### Docker

```bash

docker run -v my_dir:/output ghcr.io/openzim/wikihow wikihow2zim --help

```

### Python

`wikihow2zim` is a Python3 (**3.6+**) software. If you are not using the [Docker](https://docker.com) image, you are advised to use it in a virtual environment to avoid installing software dependencies on your system.

```bash

python3 -m venv env

source env/bin/activate

# using published version

pip3 install wikihow2zim

wikihow2zim --help

# running from source

python wikihow2zim/ --help

```

Call `deactivate` to quit the virtual environment.

See `requirements.txt` for the list of python dependencies.

## Contributing

**All contributions are welcome!**

Please open an issue on Github and/or submit a Pull-request.

### Guidelines

- Don't take assigned issues. Comment if those get staled.

- If your contribution is far from trivial, open an issue to discuss it first.

- Ensure your code passed [black formatting](https://pypi.org/project/black/), [isort](https://pypi.org/project/isort/) and [flake8](https://pypi.org/project/flake8/) (88 chars)

We have a [pre-commit](https://pre-commit.com) hook ready for you. Install it with `pip install pre-commit && pre-commit install`