Skip to main content

Make ZIM file from WikiHow articles

Project description

wikiHow

wikihow2zim is an OpenZIM scraper to create offline versions of wikiHow websites, in all its supported languages.

:zap: Scraper is known to have a very significant issue linked to throttling (https://github.com/openzim/wikihow/issues/150)

CodeFactor Docker License: GPL v3 PyPI version shields.io

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

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 image, you are advised to use it in a virtual environment to avoid installing software dependencies on your system.

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, isort and flake8 (88 chars)

We have a pre-commit hook ready for you. Install it with pip install pre-commit && pre-commit install

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wikihow2zim-1.2.3.tar.gz (2.5 MB view details)

Uploaded Source

Built Distribution

wikihow2zim-1.2.3-py3-none-any.whl (2.6 MB view details)

Uploaded Python 3

File details

Details for the file wikihow2zim-1.2.3.tar.gz.

File metadata

  • Download URL: wikihow2zim-1.2.3.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.18

File hashes

Hashes for wikihow2zim-1.2.3.tar.gz
Algorithm Hash digest
SHA256 b3d2ea31f485d78e6b0427a61fd9276d958b82f479b8545d9dc043a08ba181cc
MD5 090ef8e8a0045bdadf7ecf887dd8d9ac
BLAKE2b-256 880d64b848066b3c44a9e056f31c73a7dbfc2e46aca4feb781877fe908ee9fcb

See more details on using hashes here.

File details

Details for the file wikihow2zim-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: wikihow2zim-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.18

File hashes

Hashes for wikihow2zim-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a17d80132feefd8791158bd7696fa1d82a4296c6e2a0f1a09e3a05fceed110c6
MD5 86a681dc9fdc6492b86e21261b6b4066
BLAKE2b-256 28b200e80c01dba8b8495f04b36cf780a892d24ea87424fc9f11334ed8291a23

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page