# ZIM Scan
Minimal ZIM file reader, designed for article streaming.
## Getting Started
Install using pip:
```
pip install zimscan
```
Or from Git repository, for latest version:
```
pip install -U git+https://github.com/jojolebarjos/zimscan.git
```
Iterate over a records, which are binary file-like objects:
```python
from zimscan import Reader
path = "wikipedia_en_all_nopic_2019-10.zim"
with Reader(open(path, "rb"), skip_metadata=True) as reader:
for record in reader:
data = record.read()
...
```
## Links
* [ZIM file format](https://openzim.org/wiki/ZIM_file_format), official documentation
* [Kiwix ZIM repository](http://download.kiwix.org/zim/), to download official ZIM files
* [Wikipedia ZIM dumps](https://dumps.wikimedia.org/other/kiwix/zim/wikipedia/), to download Wikipedia ZIM files
* [ZIMply](https://github.com/kimbauters/ZIMply), a ZIM file reader in the browser, in Python
* [libzim](https://github.com/openzim/libzim), the reference implementation, in C++
* [pyzim](https://github.com/pediapress/pyzim), Python wrapper for libzim
* [pyzim](https://framagit.org/mgautierfr/pyzim), another Python wrapper for libzim
* [Internet In A Box](https://github.com/iiab/internet-in-a-box), a project to bundle open knowledge locally
Raw data
{
"_id": null,
"home_page": "https://github.com/jojolebarjos/zimscan",
"name": "zimscan",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6,<4.0",
"maintainer_email": "",
"keywords": "zim,iterator,wikipedia,gutenberg,kiwix",
"author": "Johan Berdat",
"author_email": "jojolebarjos@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f5/05/9dff0428a4e51d3b63b321f07ccea20dec8ba5c9345458de5a9425fe2ef8/zimscan-0.2.0.tar.gz",
"platform": null,
"description": "# ZIM Scan\n\nMinimal ZIM file reader, designed for article streaming.\n\n\n## Getting Started\n\nInstall using pip:\n\n```\npip install zimscan\n```\n\nOr from Git repository, for latest version:\n\n```\npip install -U git+https://github.com/jojolebarjos/zimscan.git\n```\n\nIterate over a records, which are binary file-like objects:\n\n```python\nfrom zimscan import Reader\n\npath = \"wikipedia_en_all_nopic_2019-10.zim\"\nwith Reader(open(path, \"rb\"), skip_metadata=True) as reader:\n for record in reader:\n data = record.read()\n ...\n```\n\n\n## Links\n\n * [ZIM file format](https://openzim.org/wiki/ZIM_file_format), official documentation\n * [Kiwix ZIM repository](http://download.kiwix.org/zim/), to download official ZIM files\n * [Wikipedia ZIM dumps](https://dumps.wikimedia.org/other/kiwix/zim/wikipedia/), to download Wikipedia ZIM files\n * [ZIMply](https://github.com/kimbauters/ZIMply), a ZIM file reader in the browser, in Python\n * [libzim](https://github.com/openzim/libzim), the reference implementation, in C++\n * [pyzim](https://github.com/pediapress/pyzim), Python wrapper for libzim\n * [pyzim](https://framagit.org/mgautierfr/pyzim), another Python wrapper for libzim\n * [Internet In A Box](https://github.com/iiab/internet-in-a-box), a project to bundle open knowledge locally\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "ZIM file iterator",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/jojolebarjos/zimscan",
"Repository": "https://github.com/jojolebarjos/zimscan"
},
"split_keywords": [
"zim",
"iterator",
"wikipedia",
"gutenberg",
"kiwix"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b0a9258ab47a503e312aff7138fca28852eadde9e6410e28ceba1907fae4fc97",
"md5": "360d21d8caa57552b85840cc421de756",
"sha256": "0511fd14048cb595795d967c1549ed03dc5f36d73885bca71135ad72a2e9de3a"
},
"downloads": -1,
"filename": "zimscan-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "360d21d8caa57552b85840cc421de756",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6,<4.0",
"size": 6922,
"upload_time": "2023-09-18T14:40:49",
"upload_time_iso_8601": "2023-09-18T14:40:49.187539Z",
"url": "https://files.pythonhosted.org/packages/b0/a9/258ab47a503e312aff7138fca28852eadde9e6410e28ceba1907fae4fc97/zimscan-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f5059dff0428a4e51d3b63b321f07ccea20dec8ba5c9345458de5a9425fe2ef8",
"md5": "5715ad61c8410a3fc05040bf525198aa",
"sha256": "3e2b8c60532dcb9834c2b35a2ef1743d97d8074a95df1c36d921d9a1d007645d"
},
"downloads": -1,
"filename": "zimscan-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "5715ad61c8410a3fc05040bf525198aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6,<4.0",
"size": 6040,
"upload_time": "2023-09-18T14:40:51",
"upload_time_iso_8601": "2023-09-18T14:40:51.713204Z",
"url": "https://files.pythonhosted.org/packages/f5/05/9dff0428a4e51d3b63b321f07ccea20dec8ba5c9345458de5a9425fe2ef8/zimscan-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-18 14:40:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jojolebarjos",
"github_project": "zimscan",
"github_not_found": true,
"lcname": "zimscan"
}
JSON
