Python epubcheck wrapper
Project description
Python wrappers for EpubCheck
Introduction
The original EpubCheck is the standard Java based validation tool for EPUB maintained by DAISY Consortium on behalf of the W3C, originally developed 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.2.2.
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.4, 3.5, 3.6, 3.7 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)
Documentation
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.4.2 (2019-08-07)
Update the epubcheck.jar to v4.2.2 (see: https://github.com/w3c/epubcheck/releases/tag/v4.2.2)
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.
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
Built Distribution
Hashes for epubcheck-0.4.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 060c8dd0de60ab7d2a381c85edd5aad7511bddf0b982e443020674f13acb3130 |
|
MD5 | 70ff93c6928445fa9d45fdf958ceeb41 |
|
BLAKE2b-256 | 32f0eee88e7d8b37f959ec0131578a9c8ee51b6a9df88512cb9653440dd4dee6 |