https://github.com/eggplants/mkbook

Make directory including pictures into a PDF book
https://github.com/eggplants/mkbook

Last synced: about 1 year ago
JSON representation

Make directory including pictures into a PDF book

• Host: GitHub
• URL: https://github.com/eggplants/mkbook
• Owner: eggplants
• License: mit
• Created: 2022-04-29T04:59:22.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2025-07-06T12:18:42.000Z (about 1 year ago)
• Last Synced: 2025-07-06T13:27:45.678Z (about 1 year ago)
• Language: Python
• Size: 2.51 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# mkbook

[![PyPI version](

  https://badge.fury.io/py/mkbook.svg

  )](

  https://badge.fury.io/py/mkbook

) [![pre-commit.ci status](

  https://results.pre-commit.ci/badge/github/eggplants/mkbook/master.svg

  )](

  https://results.pre-commit.ci/latest/github/eggplants/mkbook/master

) [![Maintainability](

  

  )](

  

) [![Code Coverage](

  

  )](

  

) [![Release Package](

  https://github.com/eggplants/mkbook/actions/workflows/release.yml/badge.svg

  )](

  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)