# 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.
[](https://www.codefactor.io/repository/github/openzim/wikihow)
[](https://hub.docker.com/r/openzim/wikihow)
[](https://www.gnu.org/licenses/gpl-3.0)
[](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 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`
Raw data
{
"_id": null,
"home_page": "https://kiwix.org/",
"name": "wikihow2zim",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "kiwix zim offline wikihow",
"author": "Kiwix Team",
"author_email": "dev@kiwix.org",
"download_url": "https://files.pythonhosted.org/packages/3e/cc/bf1b0421f54b80c6d1dd853e36a8df3f1e44fbe7c15db388778c37d2f4c6/wikihow2zim-1.2.2.tar.gz",
"platform": null,
"description": "# wikiHow\n\n`wikihow2zim` is an [OpenZIM](https://openzim.org) scraper to create offline versions of [wikiHow](https://www.wikihow.com) websites, in all its supported languages.\n\n[](https://www.codefactor.io/repository/github/openzim/wikihow)\n[](https://hub.docker.com/r/openzim/wikihow)\n[](https://www.gnu.org/licenses/gpl-3.0)\n[](https://pypi.org/project/wikihow2zim/)\n\n## Usage\n\n`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.\n\n### Docker\n\n```bash\ndocker run -v my_dir:/output openzim/wikihow wikihow2zim --help\n```\n\n### Python\n\n`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.\n\n```bash\npython3 -m venv env\nsource env/bin/activate\n\n# using published version\npip3 install wikihow2zim\nwikihow2zim --help\n\n# running from source\npython wikihow2zim/ --help\n```\n\nCall `deactivate` to quit the virtual environment.\n\nSee `requirements.txt` for the list of python dependencies.\n\n\n## Contributing\n\n**All contributions are welcome!**\n\nPlease open an issue on Github and/or submit a Pull-request.\n\n### Guidelines\n\n- Don't take assigned issues. Comment if those get staled.\n- If your contribution is far from trivial, open an issue to discuss it first.\n- 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)\n\nWe have a [pre-commit](https://pre-commit.com) hook ready for you. Install it with `pip install pre-commit && pre-commit install`\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "Make ZIM file from WikiHow articles",
"version": "1.2.2",
"split_keywords": [
"kiwix",
"zim",
"offline",
"wikihow"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "bca2641448daf0ad1073d7e08985549f",
"sha256": "f8b422ed130762503cecf582fa0f90fd6099100302f24baaca9587b9120c07ec"
},
"downloads": -1,
"filename": "wikihow2zim-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bca2641448daf0ad1073d7e08985549f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2633206,
"upload_time": "2022-12-30T10:15:16",
"upload_time_iso_8601": "2022-12-30T10:15:16.000129Z",
"url": "https://files.pythonhosted.org/packages/76/f0/35b18c10174219be585c2ccb6f234cd96d93f9ad370930ace10957c4849d/wikihow2zim-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "099bde225214e2336d5d0d4d0c67fedc",
"sha256": "b1cf5ec59de0da5eca4e72f10ef269d9c546d6b00b5a754e1f460bf537c80598"
},
"downloads": -1,
"filename": "wikihow2zim-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "099bde225214e2336d5d0d4d0c67fedc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2503605,
"upload_time": "2022-12-30T10:15:17",
"upload_time_iso_8601": "2022-12-30T10:15:17.741807Z",
"url": "https://files.pythonhosted.org/packages/3e/cc/bf1b0421f54b80c6d1dd853e36a8df3f1e44fbe7c15db388778c37d2f4c6/wikihow2zim-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-30 10:15:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "wikihow2zim"
}
JSON