Name | gutenberg2zim JSON |
Version |
2.1.1
JSON |
| download |
home_page | |
Summary | Make ZIM file from Gutenberg books |
upload_time | 2024-01-17 13:46:02 |
maintainer | |
docs_url | None |
author | |
requires_python | <3.12,>=3.11 |
license | GPL-3.0-or-later |
keywords |
gutenberg
kiwix
offline
zim
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
=============
gutenberg2zim
=============
A scraper that downloads the whole repository of [Project Gutenberg]
(http://www.gutenberg.org) and puts it into a locally browsable
directory and then in a ZIM file (http://www.openzim.org), a clean and
user friendly format for storing content for offline usage.
------------
Dependencies
------------
Ubuntu/debian
-------------
.. code-block:: sh
python-pip python-dev libxml2-dev libxslt-dev advancecomp jpegoptim pngquant p7zip-full gifsicle
macOS
-----
.. code-block:: sh
brew install advancecomp jpegoptim pngquant p7zip gifsicle
------
Usage
------
.. code-block:: sh
gutenberg2zim
By default (no argument), it runs all the steps: download, parse, export and zim.
.. code-block:: sh
-h --help Display this help message
-y --wipe-db Do not wipe the DB during parse stage
-F --force Redo step even if target already exist
-l --languages=<list> Comma-separated list of lang codes to filter export to (preferably ISO 639-1, else ISO 639-3)
-f --formats=<list> Comma-separated list of formats to filter export to (epub, html, pdf, all)
-m --mirror=<url> Use URL as base for all downloads.
-r --rdf-folder=<folder> Don't download rdf-files.tar.bz2 and use extracted folder instead
-e --static-folder=<folder> Use-as/Write-to this folder static HTML
-z --zim-file=<file> Write ZIM into this file path
-t --zim-title=<title> Set ZIM title
-n --zim-desc=<description> Set ZIM description
-d --dl-folder=<folder> Folder to use/write-to downloaded ebooks
-u --rdf-url=<url> Alternative rdf-files.tar.bz2 URL
-b --books=<ids> Execute the processes for specific books, separated by commas, or dashes for intervals
-c --concurrency=<nb> Number of concurrent process for download and parsing tasks
-x --zim-title=<title> Custom title for the ZIM file
-q --zim-desc=<desc> Custom description for the ZIM file
--check Check dependencies
--prepare Download & extract rdf-files.tar.bz2
--parse Parse all RDF files and fill-up the DB
--download Download ebooks based on filters
--export Export downloaded content to zim-friendly static HTML
--dev Exports *just* Home+JS+CSS files (overwritten by --zim step)
--zim Create a ZIM file
Raw data
{
"_id": null,
"home_page": "",
"name": "gutenberg2zim",
"maintainer": "",
"docs_url": null,
"requires_python": "<3.12,>=3.11",
"maintainer_email": "",
"keywords": "gutenberg,kiwix,offline,zim",
"author": "",
"author_email": "Kiwix <dev@kiwix.org>",
"download_url": "https://files.pythonhosted.org/packages/56/61/b6df994e6b90c8f6daa815c6475c839f0137639cf2c4179cfd3403f342c9/gutenberg2zim-2.1.1.tar.gz",
"platform": null,
"description": "=============\ngutenberg2zim\n=============\n\nA scraper that downloads the whole repository of [Project Gutenberg]\n(http://www.gutenberg.org) and puts it into a locally browsable\ndirectory and then in a ZIM file (http://www.openzim.org), a clean and\nuser friendly format for storing content for offline usage.\n\n------------\nDependencies\n------------\n\nUbuntu/debian\n-------------\n\n.. code-block:: sh\n\n python-pip python-dev libxml2-dev libxslt-dev advancecomp jpegoptim pngquant p7zip-full gifsicle\n\n\nmacOS\n-----\n\n.. code-block:: sh\n\n brew install advancecomp jpegoptim pngquant p7zip gifsicle\n\n------\nUsage\n------\n\n.. code-block:: sh\n\n\tgutenberg2zim\n\nBy default (no argument), it runs all the steps: download, parse, export and zim.\n\n\n.. code-block:: sh\n \n\t-h --help Display this help message\n\t-y --wipe-db Do not wipe the DB during parse stage\n\t-F --force Redo step even if target already exist\n\n\t-l --languages=<list> Comma-separated list of lang codes to filter export to (preferably ISO 639-1, else ISO 639-3)\n\t-f --formats=<list> Comma-separated list of formats to filter export to (epub, html, pdf, all)\n\n\t-m --mirror=<url> Use URL as base for all downloads.\n\t-r --rdf-folder=<folder> Don't download rdf-files.tar.bz2 and use extracted folder instead\n\t-e --static-folder=<folder> Use-as/Write-to this folder static HTML\n\t-z --zim-file=<file> Write ZIM into this file path\n\t-t --zim-title=<title> Set ZIM title\n\t-n --zim-desc=<description> Set ZIM description\n\t-d --dl-folder=<folder> Folder to use/write-to downloaded ebooks\n\t-u --rdf-url=<url> Alternative rdf-files.tar.bz2 URL\n\t-b --books=<ids> Execute the processes for specific books, separated by commas, or dashes for intervals\n\t-c --concurrency=<nb> Number of concurrent process for download and parsing tasks\n\n\t-x --zim-title=<title> Custom title for the ZIM file\n\t-q --zim-desc=<desc> Custom description for the ZIM file\n\n\t--check Check dependencies\n\t--prepare Download & extract rdf-files.tar.bz2\n\t--parse Parse all RDF files and fill-up the DB\n\t--download Download ebooks based on filters\n\t--export Export downloaded content to zim-friendly static HTML\n\t--dev Exports *just* Home+JS+CSS files (overwritten by --zim step)\n\t--zim Create a ZIM file\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Make ZIM file from Gutenberg books",
"version": "2.1.1",
"project_urls": {
"Donate": "https://www.kiwix.org/en/support-us/",
"Homepage": "https://github.com/openzim/kolibri"
},
"split_keywords": [
"gutenberg",
"kiwix",
"offline",
"zim"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c4cee3071df62f4b2676a8d67c70229c4f5225e7ec980bc1099a37d812e96cfc",
"md5": "a56aedc86729cf133d3ab27c699879eb",
"sha256": "7862c263521aff21f55bb74429b225c368ccbf06f204421f6f7e61e0c1acf63e"
},
"downloads": -1,
"filename": "gutenberg2zim-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a56aedc86729cf133d3ab27c699879eb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.11",
"size": 1399213,
"upload_time": "2024-01-17T13:46:00",
"upload_time_iso_8601": "2024-01-17T13:46:00.132631Z",
"url": "https://files.pythonhosted.org/packages/c4/ce/e3071df62f4b2676a8d67c70229c4f5225e7ec980bc1099a37d812e96cfc/gutenberg2zim-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5661b6df994e6b90c8f6daa815c6475c839f0137639cf2c4179cfd3403f342c9",
"md5": "6d17a56353adad5e6b47c225e3095a21",
"sha256": "ca8402a81c905622217199001ba587a39768980909203dee93c80b23752135c8"
},
"downloads": -1,
"filename": "gutenberg2zim-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "6d17a56353adad5e6b47c225e3095a21",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.11",
"size": 1517512,
"upload_time": "2024-01-17T13:46:02",
"upload_time_iso_8601": "2024-01-17T13:46:02.651833Z",
"url": "https://files.pythonhosted.org/packages/56/61/b6df994e6b90c8f6daa815c6475c839f0137639cf2c4179cfd3403f342c9/gutenberg2zim-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-17 13:46:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openzim",
"github_project": "kolibri",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gutenberg2zim"
}