json-ptr

A Python 2.7 implementation of IETF RFC 6901.

Please click here to go to the docs.

See the package hosted on pypi.

Usage

Installation

pip install json-ptr

Importing

from json_pointer import evaluate, JsonPointer, JsonPointerException

See the documentation linked above for examples.

Contributing

Getting the code

Fork the repository, then:

git clone https://github.com/<username>/json-ptr.git
cd json-pointer
make install-full

The install-full make directive installs all module, test, and development external dependencies. From there, simply open a PR against master (please add unit tests where applicable) and note that test coverage must meet a certain percentage threshold, otherwise the unit test build will fail.

The install-full directive also initializes the the git submodule for the json-pointer docs located here. To regenerate the documentation sources run the following from the project root folder:

cd docs
make regen

Finally, running make run-tests will execute all unit tests for the module.