README

Overview
========

**python-djvulibre** is a set of Python bindings for
the DjVuLibre_ library, an open source implementation of DjVu_.

.. _DjVuLibre:
   http://djvu.sourceforge.net/
.. _DjVu:
   http://djvu.org/

Prerequisites
=============

The following software is required to build python-djvulibre:

* DjVuLibre (≥ 3.5.26)
* Python_ (≥ 3.6)
* Cython_ (≥ 0.28)
* pkg-config_ (required on POSIX systems)

Additionally, the following software is needed to run the tests:

* DjVuLibre_ command-line tools
* Ghostscript_

.. _Python:
   https://www.python.org/
.. _Cython:
   https://cython.org/
.. _pkg-config:
   https://wiki.freedesktop.org/www/Software/pkg-config/
.. _Ghostscript:
   https://www.ghostscript.com/

About this fork
===============

This repository is a Python3-only version of the original repository.

Due to the upstream repository having been archived (`Issue #23`_), this fork will now be maintained on its own. Please note that I do not have any plans on implementing completely new features for now. Nevertheless, I am going to try to keep this fork working for at least the parts which I actually use on a regular basis (as part of *ocrodjvu*).

Differences from upstream
-------------------------

* Package requires Python ≥ 3.6.
* Conform to PEP8 coding style.
* Refactor build to not use the deprecated *distutils* module any more.
* Drop support for building the package on Windows. I do not use it there and there have not been automated tests for it. If someone wants to get this back to work and help maintaining it, feel free to open an issue.
* Add support for Cython 3.0, while dropping some old backwards-compatibility code.

.. _Issue #23:
   https://github.com/jwilk-archive/python-djvulibre/issues/23

Acknowledgment
==============

python-djvulibre development was supported by the Polish Ministry of Science
and Higher Education's grant no. N N519 384036 (2009–2012,
https://bitbucket.org/jsbien/ndt).