python-webpub-manifest-parser

A parser for the Readium Web Publication Manifest (RWPM) and Open Publication Distribution System 2.0 (OPDS 2.0) formats.

Usage

1. Install pyenv

2. Install one of the supported Python versions mentioned in .python-version or other PATCH versions of the same MINOR versions:

pyenv install <python-version>

4. Install pyenv-virtualenv plugin

5. Create a virtual environment:

pyenv virtualenv <virtual-env-name>
pyenv activate <virtual-env-name>

6. Install the library

pip install webpub-manifest-parser

Setting up a development environment

Running tests using tox

1. Make sure that a virtual environment is not activated and deactivate it if needed:

deactivate

2. Install tox and tox-pyenv globally:

pip install tox tox-pyenv

3. Make your code prettier using isort and black:

make reformat

4. Run the linters:

make lint

5. To run the unit tests use the following command:

make test-<python-version>

where <python-version> is one of supported python versions:

• py27
• py36
• py37
• py38

For example, to run the unit test using Python 2.7 run the following command:

make test-py27