palace_webpub_manifest_parser 2.0.4

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

webpub manifest parser

A parser for the Readium Web Publication Manifest (RWPM), Open Publication Distribution System 2.0 (OPDS 2.0), and Open Distribution to Libraries 1.0 (ODL) formats.

Usage

Install the library with pip

pip install palace-webpub-manifest-parser

Pyenv

You can optionally install the python version to run the library with using pyenv.

1. Install pyenv

2. Install one of the supported Python 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 palace-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

Releasing

Releases will be automatically published to PyPI when new releases are created on github. We use bump2version to update the version number, then create a release in github.

To publish a new release:

• Bump the version and push it as a branch

  git checkout -b release/vX.X.X
  pip install bump2version
  bump2version {part}
  git push origin release/vX.X.X
  

• Create a PR for new version
• Merge PR into main
• Create a release for the version in github