# mkbook
[](
https://badge.fury.io/py/mkbook
) [](
https://results.pre-commit.ci/latest/github/eggplants/mkbook/master
) [](
https://codeclimate.com/github/eggplants/mkbook/maintainability
) [](
https://github.com/eggplants/mkbook/actions/workflows/release.yml
)
- Make directory including pictures into a PDF book.
- This package and tool are mainly made for [getjump](https://github.com/eggplants/getjump)
- FOR PERSONAL USE ONLY. Generated PDF must not be distributed to other people.
## Install
```sh
pip install mkbook
# or:
pip install git+https://github.com/eggplants/mkbook
```
## CLI
```shellsession
$ mkbook ~/Pictures/タコピーの原罪 takop.pdf
Saving...
Done: /Users/eggplants/prog/mkbook/takop.pdf
$ file takop.pdf
takop.pdf: PDF document, version 1.4
$ mkbook ~/Pictures/タコピーの原罪 takop.pdf
'takop.pdf' already exists. Use `-o` to overwrite.
```
```shellsession
$ mkbook -h
usage: mkbook [-h] [-f FONT_SIZE] [-F TT_FONT] [-o] [-V] PATH PATH
Make directory including pictures into a PDF book
positional arguments:
PATH target dir
PATH saved pdf file path
optional arguments:
-h, --help show this help message and exit
-f FONT_SIZE, --font-size FONT_SIZE overwrite if pdf path exists (default: 20)
-F TT_FONT, --tt-font TT_FONT truetype font file
-o, --overwrite
-V, --version show program's version number and exit
note:
This package and tool are mainly made for getjump.
https://github.com/eggplants/getjump
```
## License
MIT
### Licenses of fonts
- [Rampart](https://github.com/fontworks-fonts/Rampart/blob/master/fonts/ttf/RampartOne-Regular.ttf)
[The Open Font License (OFL)](https://github.com/fontworks-fonts/Rampart/blob/master/OFL.txt)
Raw data
{
"_id": null,
"home_page": "https://github.com/eggplants/mkbook",
"name": "mkbook",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": "getjump, pdf, conbine",
"author": "eggplants",
"author_email": "w10776e8w@yahoo.co.jp",
"download_url": "https://files.pythonhosted.org/packages/c6/3f/3d41ce76f0002bbf3ffc14f55e1981f39f2115b8f484d4031ac9dff28c0a/mkbook-0.0.3.tar.gz",
"platform": null,
"description": "# mkbook\n\n[](\n https://badge.fury.io/py/mkbook\n) [](\n https://results.pre-commit.ci/latest/github/eggplants/mkbook/master\n) [](\n https://codeclimate.com/github/eggplants/mkbook/maintainability\n) [](\n https://github.com/eggplants/mkbook/actions/workflows/release.yml\n)\n\n- Make directory including pictures into a PDF book.\n- This package and tool are mainly made for [getjump](https://github.com/eggplants/getjump)\n - FOR PERSONAL USE ONLY. Generated PDF must not be distributed to other people.\n\n## Install\n\n```sh\npip install mkbook\n# or:\npip install git+https://github.com/eggplants/mkbook\n```\n\n## CLI\n\n```shellsession\n$ mkbook ~/Pictures/\u30bf\u30b3\u30d4\u30fc\u306e\u539f\u7f6a takop.pdf\nSaving...\nDone: /Users/eggplants/prog/mkbook/takop.pdf\n\n$ file takop.pdf\ntakop.pdf: PDF document, version 1.4\n\n$ mkbook ~/Pictures/\u30bf\u30b3\u30d4\u30fc\u306e\u539f\u7f6a takop.pdf\n'takop.pdf' already exists. Use `-o` to overwrite.\n```\n\n```shellsession\n$ mkbook -h\nusage: mkbook [-h] [-f FONT_SIZE] [-F TT_FONT] [-o] [-V] PATH PATH\n\nMake directory including pictures into a PDF book\n\npositional arguments:\n PATH target dir\n PATH saved pdf file path\n\noptional arguments:\n -h, --help show this help message and exit\n -f FONT_SIZE, --font-size FONT_SIZE overwrite if pdf path exists (default: 20)\n -F TT_FONT, --tt-font TT_FONT truetype font file\n -o, --overwrite\n -V, --version show program's version number and exit\n\nnote:\n This package and tool are mainly made for getjump.\n https://github.com/eggplants/getjump\n```\n\n## License\n\nMIT\n\n### Licenses of fonts\n\n- [Rampart](https://github.com/fontworks-fonts/Rampart/blob/master/fonts/ttf/RampartOne-Regular.ttf)\n\n[The Open Font License (OFL)](https://github.com/fontworks-fonts/Rampart/blob/master/OFL.txt)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Make directory including pictures into a PDF book",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/eggplants/mkbook",
"Repository": "https://github.com/eggplants/mkbook"
},
"split_keywords": [
"getjump",
" pdf",
" conbine"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0dcf6ce6cc9dca19dfb74bf5a5e51ade36c5c6d0f7477794257570125514f77b",
"md5": "4cfe6b7f071c9b108024db80e86abca2",
"sha256": "964285daa7c63a5e79ec11969ff6d2c2fee074197fff0cf76ccebe02a01e0c4f"
},
"downloads": -1,
"filename": "mkbook-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4cfe6b7f071c9b108024db80e86abca2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 2501183,
"upload_time": "2025-01-04T20:35:58",
"upload_time_iso_8601": "2025-01-04T20:35:58.809507Z",
"url": "https://files.pythonhosted.org/packages/0d/cf/6ce6cc9dca19dfb74bf5a5e51ade36c5c6d0f7477794257570125514f77b/mkbook-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c63f3d41ce76f0002bbf3ffc14f55e1981f39f2115b8f484d4031ac9dff28c0a",
"md5": "6549ad0bd63a8efd3a5245380519c611",
"sha256": "a5f301f454942c2bd14d17bfad92241edd573cc0c520b12f608d7342626ac51d"
},
"downloads": -1,
"filename": "mkbook-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "6549ad0bd63a8efd3a5245380519c611",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 2497282,
"upload_time": "2025-01-04T20:36:00",
"upload_time_iso_8601": "2025-01-04T20:36:00.684832Z",
"url": "https://files.pythonhosted.org/packages/c6/3f/3d41ce76f0002bbf3ffc14f55e1981f39f2115b8f484d4031ac9dff28c0a/mkbook-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-04 20:36:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "eggplants",
"github_project": "mkbook",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkbook"
}
JSON
