ebook-homebrew

Ebook_homebrew

The Ebook_homebrew is changing file name to only digit name like 001.jpg and make e-book format files.

http://img.shields.io/badge/license-MIT-blue.svg?style=flat

https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square

https://codecov.io/gh/tubone24/ebook_homebrew/branch/master/graph/badge.svg

https://img.shields.io/codeclimate/tech-debt/tubone24/ebook_homebrew.svg?style=flat

https://scrutinizer-ci.com/g/tubone24/ebook_homebrew/badges/quality-score.png?b=master

https://scrutinizer-ci.com/g/tubone24/ebook_homebrew/badges/code-intelligence.svg?b=master

https://ci.appveyor.com/api/projects/status/mx93pu69tqkngjxv?svg=true

https://img.shields.io/appveyor/tests/tubone24/ebook-homebrew.svg?style=flat

https://dev.azure.com/meitantei-conan/ebook_homebrew/_apis/build/status/tubone24.ebook_homebrew?branchName=master

https://img.shields.io/azure-devops/tests/meitantei-conan/ebook_homebrew/1.svg?compact_message&style=flat

https://api.shippable.com/projects/5c64353c33944406008b4ae8/badge?branch=master

https://circleci.com/gh/tubone24/ebook_homebrew.svg?style=svg

https://api.codacy.com/project/badge/Grade/d25ad1bd88f24a0abfb2d801034be820

https://snyk.io/test/github/tubone24/ebook_homebrew/badge.svg?targetFile=requirements.txt

https://img.shields.io/badge/code%20style-black-000000.svg

https://img.shields.io/pypi/dm/ebook-homebrew.svg

https://img.shields.io/pypi/pyversions/ebook-homebrew.svg

https://img.shields.io/pypi/format/ebook-homebrew.svg

https://img.shields.io/gitter/room/tubone24/ebook_homebrew.svg

https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg

https://beerpay.io/tubone24/ebook_homebrew/badge.svg

ebook_homebrew is command line interface which change file name to only digit name like 001.jpg and make e-book format files.

Getting Started

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

Using setup.py

$ python setup.py install

Or using pip installer

$ pip install ebook-homebrew

Usage

You can use global command ebookhomebrew .

Show help.

$ ebookhomebrew -h

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

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

Ex2) Run Rest API Server for converting pdf from images.

$ ebookhomebrew api -p 8080

ebookhomebrew command line interface

You can use ebookhomebrew command line interface.

Subcommands

Choose subcommands. Usually choose "auto"
{auto,api,makezip}
 auto      Make only digit file name, convert e-book file such as PDF
 api               Provides Rest API interfaces
 makezip           Make zip file for adding specify extension files.

Options auto

-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.

Options api

optional arguments:
-h, --help            show this help message and exit
-p PORT, --port PORT  API Server Port

Testing

Unit Test

Using pytest, if you want to test.

$ pytest

If you get coverage report, run coverage and report.

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

Or pytest-cov param for pytest

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

Integration Test

Using pytest, if you want to test with mark “–it”

$ pytest --it

With tox

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

$ tox

CI/CD

This Repo is studies repo which CI/CD Config by tubone. Check config on this repo!

Travis-CI

This repository uses Travis-CI and be building jobs by push or PR branches.

Codecov

Also you can check coverage with Codecov

CodeClimate

You can check the code maintainability, smells and technical debt with CodeClimate

Scrutinizer

Scrutinizer is the CI which build app and check code quality

Appveyor

Appveyor is the CI which use Windows Platform and Push the artifacts to PyPI

Azure Pipelines

This repo use Azure Dev Ops Azure Pipelines with platform MacOS.

Shippable

Shippable is the CI use Docker containers.

CircleCI

CircleCI is the great CI which can use selenium (not use selenium test in this repo but use ebook-homebrew-vue-typescript-client).

LGTM

LGTM is code smells check.

Snyk

Snyk is fix and prevent vulnerabilities in this code.

Readthedocs

This repo use ReadTheDocs by Docs.

DockerHub

Push master branch, build docker container with DockerHub

Examples

Stand Alone Web GUI

Stand alone Web GUI. Such as Create PDF from your images by using Flask.

Command Line Tools with using Rest API

Command Line Tools which client app for REST API.

Client App with ebook-homebrew’s rest API

Vue.js Frontend App

Using Vue.js, Call REST API.

ebook-homebrew-vue-client (deprecated)

ebook-homebrew-vue-typescript-client

Rust Command Line Client

Using Rust, Call REST API by CLI

ebook-homebrew-rust-client

Deploy API to Heroku

Deploy Ebook-homebrew to Heroku app.

Push a button below.

DEMOS

REST API

The ebook-homebrew REST API DEMO is deploy to Heroku.

https://ebook-homebrew.herokuapp.com/

REST API DOCS (OPENAPI)

With Vue.js Front

Using Vue.js, Call REST API DEMO App, deploy to Heroku.

https://ebook-homebrew.herokuapp.com/#/sample

With Flutter Android App

Using Flutter, Call REST API DEMO Android App, deploy to Deploygate. Try me!

And also, you can download to Google Play

GitPitch

Ebook Homebrew presentation is made in GitPitch.

GitPitch

Licence

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

API Document

The Document write by Sphinx.

Changelog

v1.0.0 (2019-1-14)

First release.

v1.1.0 (2019-02-05)

Rename to digit filename a little bit speedy for using asyncio
More Testcase(Windows)

v2.0.0 (2019-04-20)

Rest API Interface.

v2.1.0 (2019-07-29)

Use Sqlite3 and save uploadID
Typescript Demo app

v2.1.1 (2019-08-28)

Create Logo.

v2.1.3 (2019-09-14)

Fix Vulnerability
Awesome Design
Result List

Release files for ebook-homebrew 2.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ebook-homebrew 2.1.4
File	Size	Uploaded
ebook_homebrew-2.1.4.tar.gz	19.7 kB	Sep 28, 2019	Details

Built distributions (wheels)

Table of built distributions (wheels) for ebook-homebrew 2.1.4
File	Interpreter	ABI	Platform	Reset
ebook_homebrew-2.1.4-py3.7.egg 49.7 kB Sep 28, 2019	Legacy Egg format	-	-	Details
ebook_homebrew-2.1.4-py2.py3-none-any.whl 24.2 kB Sep 28, 2019	Python 2, Python 3	none	any	Details

Total release size: 93.6 kB

Release files / ebook_homebrew-2.1.4.tar.gz

Download URL	ebook_homebrew-2.1.4.tar.gz
Size	19.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`d6fff1ad0984b1019df4e952944587d0995b56b0b7be5e8909254b1c8af4688f`
BLAKE2b-256 checksum How to use checksums	`2ee8d4fd6b80e4b7173d7c5069a059072247b797270d0519bcb0344da106d9c6`
Upload date	Sep 28, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/2.7.16`

Release files / ebook_homebrew-2.1.4-py3.7.egg

Download URL	ebook_homebrew-2.1.4-py3.7.egg
Size	49.7 kB
Tags	Egg
SHA-256 checksum How to use checksums	`6cd25e6e5d4dbdf4948b8f966b0a2569e6180e18055197abc068b47700b9f8bc`
BLAKE2b-256 checksum How to use checksums	`30b83f4cd94619c221babb05fd4d076a4abad9804c4b840bc4f3a1aa066b2f64`
Upload date	Sep 28, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/2.7.16`

Release files / ebook_homebrew-2.1.4-py2.py3-none-any.whl

Download URL	ebook_homebrew-2.1.4-py2.py3-none-any.whl
Size	24.2 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`63718367153ff9d5a8a47f0aa355ee5cf42f96c837dc6c6363d37cac74b97a19`
BLAKE2b-256 checksum How to use checksums	`76347fdcb4a8e3a7e5558dc46c25f0e6d77218b742a9ee24de85ef1067eac2d9`
Upload date	Sep 28, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/2.7.16`