ebook-homebrew 1.1.0

Rename image file to only digit name and convert ebook files.

![ebook_homebrew](https://raw.githubusercontent.com/tubone24/ebook_homebrew/master/doc_src/bookicon.png
"ebook_homebrew_icon")


# ebook_homebrew

[](LICENSE)
[](http://makeapullrequest.com)
[](https://travis-ci.org/tubone24/ebook_homebrew)
[](https://ebook-homebrew.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/gh/tubone24/ebook_homebrew)
[](https://codeclimate.com/github/tubone24/ebook_homebrew/maintainability)
[](https://scrutinizer-ci.com/g/tubone24/ebook_homebrew/?branch=master)
[](https://scrutinizer-ci.com/code-intelligence)
[](https://ci.appveyor.com/project/tubone24/ebook-homebrew)
[](https://lgtm.com/projects/g/tubone24/ebook_homebrew/alerts/)
[](https://lgtm.com/projects/g/tubone24/ebook_homebrew/context:python)
[](https://pypi.org/project/ebook-homebrew/)
[](https://waffle.io/tubone24/ebook_homebrew)

Change file name to only digit name like `001.jpg` and make e-book format files.

## Getting Started

Ebook_homebrew is a python package, so that you can use `setup.py` or `pip` installer.

### Using setup.py

```bash
$ python setup.py install
```

### Or using pip installer


```bash
$ pip install ebook-homebrew
```

## Usage

You can use global command "ebookhomebrew".

Show help.

```bash
$ ebookhomebrew -h
```

Ex) Rename image file to only digit and Create PDF file.

```bash
$ ebookhomebrew auto -s ./tests -d 3,4 -e jpg -f test.pdf
```

### ebookhomebrew command line interface

#### Subcommands

```bash
Choose subcommands. Usually choose "auto"

{auto}
auto Make only digit file name, convert e-book file such as PDF
```

#### Options

```bash
-h, --help show this help message and exit
-s SRC_DIR, --src_dir SRC_DIR
Source directory which put original image files.
--dst_dir DST_DIR Destination directory which put e-book file.
-d N,N, --digit N,N Serial number digits you remain file name
-e EXT, --extension EXT
Destination directory which put e-book file.
-f FILENAME, --filename FILENAME
Destination directory which put e-book file.
-m, --manual Duplicate file name, solving manually.
-r, --remove Remove original image file.
-y, --assume_yes no verify users.
```

## Testing

### Unit Test

Using pytest, if you want to test.

```bash
pytest
```

If you get coverage report, run coverage and report.

```bash
$ coverage run --source=ebook_homebrew -m pytest
$ coverage report -m
```

Or pytest-cov param for pytest

```bash
$ pytest --cov=ebook_homebrew --cov-report html --cov-report xml
```

### Integration Test

Using pytest, if you want to test with mark "--it"

```bash
pytest --it
```

### With tox

With tox, you can test multiple python version.(only python3.5, 3.6)

```bash
tox
```

### Travis-CI

This repository uses [Travis-CI](https://travis-ci.org/) and be building jobs by push or PR branches.

## Licence

This software is released under the MIT License, see LICENSE.

## API Document

See `Read the Docs`

[document](https://ebook-homebrew.readthedocs.io/en/latest/)
# Changelog

## [v1.0.0](https://github.com/tubone24/ebook_homebrew/releases/tag/v1.0.0) (2019-1-14)

First release.