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.

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 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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: wikihow2zim-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for wikihow2zim-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0206a4d00233f389d97eab1e7d16b917d0ca8fe980f52d46bfbe78a07e8524b6
MD5 98b9b4626560abb9e69a48b345f25320
BLAKE2b-256 8d532d4c9a7e554c9a2f9ce609c9138455506925fb78ea9433893491ca39917f

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