Skip to main content
Help us improve Python packaging – donate today!

Python epubcheck wrapper

Project Description

Python wrappers for EpubCheck

Documentation Status Travis-CI Build Status AppVeyor Build Status Coverage Status

Introduction

The original EpubCheck is the standard Java based validation tool for EPUB provided by the IDPF.

This package provides a Python libary and command line tool for convenient validation of EPUB files by wrapping the original EpubCheck 4.0.1.

  • Free software: BSD license

Installation

If you have Python on your system you can do the usual:

pip install epubcheck

You must have Python & Java installed on your system. The original Java EpubCheck command line client itself is bundled in the PyPi package.

This package is tested with Python 2.7, 3.3, 3.4, 3.5 on Linux and Windows. It should also work with PyPy.

Quickstart

Command line usage examples

Validata all epub files in the current directory:

$ epubcheck

Validate a single EPUB file:

$ epubcheck /path/to/book.epub

Validate all files in /epubfolder and create a detailed Excel report:

$ epubcheck /path/epubfolder --xls report.xls

Show command line help:

$ epubcheck -h

Using epubcheck as a python library

>>> from epubcheck import EpubCheck
>>> result = EpubCheck('src/epubcheck/samples/invalid.epub')
>>> print(result.valid)
>>> print(result.messages)

Development

To run the all tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows
set PYTEST_ADDOPTS=--cov-append
tox
Other
PYTEST_ADDOPTS=--cov-append tox

Credits

EpubCheck is a project coordinated by IDPF. Most of the EpubCheck functionality comes from the schema validation tool Jing and schemas that were developed by IDPF and DAISY. Initial EpubCheck development was largely done at Adobe Systems.

Changelog

0.3.1 (2016-04-20)

  • Added custom PY2/PY3 compat module and removed dependancy on six

0.3.0 (2016-04-10)

  • Add commandline support with Excel batch reporting
  • Moved development status from Alpha to Beta

0.2.0 (2016-04-03)

  • EpubCheck results as native python objects
  • More documentation

0.1.0 (2016-04-01)

  • First release on PyPI.

Release history Release notifications

This version
History Node

0.3.1

History Node

0.3.0

History Node

0.2.0

History Node

0.1.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
epubcheck-0.3.1-py2.py3-none-any.whl (8.3 MB) Copy SHA256 hash SHA256 Wheel py2.py3 Apr 20, 2016
epubcheck-0.3.1.zip (8.3 MB) Copy SHA256 hash SHA256 Source None Apr 20, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page