# ebookconverter
code that orchestrates ebook conversion for project gutenberg
EbookConverter manages the creation and update of ebook assets for Project Gutenberg. It uses a postgres database to keep track of both ebook metadata and ebook files. the postgress database is managed by the libgutenberg package.
The cron-rebuild-files.sh script runs as a cron job, rebuilding 2100 books per day, so as to rebuild every book roughly once a month.
ebookconverter talks to the gutenberg database to build a list of ebookmaker jobs. These jobs require some metadata about the book, and a target file to process.
ebookconverter expects source files to be in numbered directories in a 'files' directory. The location of the files directory is given by the FILESDIR config parameter.
Config parameters should be set in a file at /etc/ebookconverter.conf or ~/.ebookconverter
ebookconverter has been tested on Python 3.9.
## Installing
`pipenv install ebookconverter`
The following directories should exist:
- $PRIVATE/logs
- $PRIVATE/logs/json
- $PRIVATE/logs/json/backup
- $PRIVATE/logs/notifications
- $PRIVATE/logs/dopush
- $PRIVATE/logs/dopush/backup
## Using the EbookConverter Scripts
you can run these commands either by first entering a `pipenv shell` or on a single line using `pipenv run <command> <args>`
Rebuild one or more books
`ebookconverter --range=<start>-<finish> --build=all`
`ebookconverter --range=<booknumber> --build=all`
`ebookconverter --range=<booknumber> --build=all --validate`
Reload metadata from a workflow json file (use with care, it will overwrite any metadata in the DB)
`reload_workflow <booknumber>`
Regenerate the csv file
`make_csv`
Look for any ebooks with changed files in the last X days and then check if any of the previously known files of that ebook have been deleted.
`autodelete`
Raw data
{
"_id": null,
"home_page": "https://github.com/gutenbergtools/ebookconverter/",
"name": "ebookconverter",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Eric Hellman",
"author_email": "eric@hellman.org",
"download_url": "https://files.pythonhosted.org/packages/82/ab/4548d56968d8a0b29bd0c3ada1ffd35018608e4dcacc3ab516443ef78593/ebookconverter-0.9.10.tar.gz",
"platform": "OS-independent",
"description": "# ebookconverter\ncode that orchestrates ebook conversion for project gutenberg\n\n\nEbookConverter manages the creation and update of ebook assets for Project Gutenberg. It uses a postgres database to keep track of both ebook metadata and ebook files. the postgress database is managed by the libgutenberg package.\n\nThe cron-rebuild-files.sh script runs as a cron job, rebuilding 2100 books per day, so as to rebuild every book roughly once a month.\n\nebookconverter talks to the gutenberg database to build a list of ebookmaker jobs. These jobs require some metadata about the book, and a target file to process.\n\nebookconverter expects source files to be in numbered directories in a 'files' directory. The location of the files directory is given by the FILESDIR config parameter.\n\nConfig parameters should be set in a file at /etc/ebookconverter.conf or ~/.ebookconverter\n\nebookconverter has been tested on Python 3.9.\n\n## Installing\n\n`pipenv install ebookconverter`\n\nThe following directories should exist:\n - $PRIVATE/logs\n - $PRIVATE/logs/json\n - $PRIVATE/logs/json/backup\n - $PRIVATE/logs/notifications\n - $PRIVATE/logs/dopush\n - $PRIVATE/logs/dopush/backup\n\n## Using the EbookConverter Scripts\n\nyou can run these commands either by first entering a `pipenv shell` or on a single line using `pipenv run <command> <args>`\n\nRebuild one or more books\n`ebookconverter --range=<start>-<finish> --build=all`\n`ebookconverter --range=<booknumber> --build=all`\n`ebookconverter --range=<booknumber> --build=all --validate`\n\nReload metadata from a workflow json file (use with care, it will overwrite any metadata in the DB)\n`reload_workflow <booknumber>`\n\nRegenerate the csv file\n`make_csv`\n\nLook for any ebooks with changed files in the last X days and then check if any of the previously known files of that ebook have been deleted.\n\n`autodelete`\n",
"bugtrack_url": null,
"license": "GPL v3",
"summary": "The Project Gutenberg tool to orchestrate ebook generation.",
"version": "0.9.10",
"project_urls": {
"Homepage": "https://github.com/gutenbergtools/ebookconverter/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "82ab4548d56968d8a0b29bd0c3ada1ffd35018608e4dcacc3ab516443ef78593",
"md5": "e7543f5d5263fe8a779f197677d6632a",
"sha256": "c958e3d48c6c0383f2ab77273a792f2195372d70d2c698302e608ea9946b3b87"
},
"downloads": -1,
"filename": "ebookconverter-0.9.10.tar.gz",
"has_sig": false,
"md5_digest": "e7543f5d5263fe8a779f197677d6632a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 45404,
"upload_time": "2025-01-22T23:04:43",
"upload_time_iso_8601": "2025-01-22T23:04:43.751276Z",
"url": "https://files.pythonhosted.org/packages/82/ab/4548d56968d8a0b29bd0c3ada1ffd35018608e4dcacc3ab516443ef78593/ebookconverter-0.9.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-22 23:04:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gutenbergtools",
"github_project": "ebookconverter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ebookconverter"
}
JSON
