Skip to main content

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

Project description

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


# ebook_homebrew

[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![Build Status](https://travis-ci.org/tubone24/ebook_homebrew.svg?branch=master)](https://travis-ci.org/tubone24/ebook_homebrew)
[![Documentation Status](https://readthedocs.org/projects/ebook-homebrew/badge/?version=latest)](https://ebook-homebrew.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/tubone24/ebook_homebrew/branch/master/graph/badge.svg)](https://codecov.io/gh/tubone24/ebook_homebrew)
[![Maintainability](https://api.codeclimate.com/v1/badges/a3e2d70a87998a18e225/maintainability)](https://codeclimate.com/github/tubone24/ebook_homebrew/maintainability)
![Downloads](https://img.shields.io/pypi/dm/ebook-homebrew.svg)
![PyPi](https://img.shields.io/pypi/v/ebook-homebrew.svg)
![Python version](https://img.shields.io/pypi/pyversions/ebook-homebrew.svg)
[![format](https://img.shields.io/pypi/format/ebook-homebrew.svg)](https://pypi.org/project/ebook-homebrew/)
![Gitter](https://img.shields.io/gitter/room/tubone24/ebook_homebrew.svg)

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ebook_homebrew-1.0.1a1.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ebook_homebrew-1.0.1a1-py2.py3-none-any.whl (17.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file ebook_homebrew-1.0.1a1.tar.gz.

File metadata

  • Download URL: ebook_homebrew-1.0.1a1.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.19.8 CPython/3.6.1

File hashes

Hashes for ebook_homebrew-1.0.1a1.tar.gz
Algorithm Hash digest
SHA256 78bbfe6b65ee179c392e788a0eda70b397f81bfcf2c888d64d11ad898294f89d
MD5 ba94cdf53fac15c12a409d6ba704018b
BLAKE2b-256 6534cb7708b29e93c2b4bb6c34be0d97c92960d35e068e1f8575e7e41dec4c3b

See more details on using hashes here.

File details

Details for the file ebook_homebrew-1.0.1a1-py2.py3-none-any.whl.

File metadata

  • Download URL: ebook_homebrew-1.0.1a1-py2.py3-none-any.whl
  • Upload date:
  • Size: 17.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.19.8 CPython/3.6.1

File hashes

Hashes for ebook_homebrew-1.0.1a1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 311a87e4f4f7de09674d8cd76c0e714675ba50e96ef9aac6b1ea975444e71d6d
MD5 c15ea4706c51b931a0ef7e5c9bd66ae4
BLAKE2b-256 d22d510e48f919fbe526469202e0f3e7ec40dfda21838e9970ceb6e1a6950246

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page