Skip to main content

A parser for the Readium Web Publication Manifest and OPDS 2.0 formats.

Project description

python-webpub-manifest-parser

Build Status

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>
  1. Install pyenv-virtualenv plugin

  2. Create a virtual environment:

pyenv virtualenv <virtual-env-name>
pyenv activate <virtual-env-name>
  1. 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
  1. Install tox and tox-pyenv globally:
pip install tox tox-pyenv
  1. Make your code prettier using isort and black:
make reformat
  1. Run the linters:
make lint
  1. 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

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

webpub_manifest_parser-0.0.4.tar.gz (30.4 kB view hashes)

Uploaded Source

Built Distribution

webpub_manifest_parser-0.0.4-py2.py3-none-any.whl (38.2 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page