Skip to content

Gr1N/jsonpointer-helpers

Folders and files

NameName
Last commit message
Last commit date

Latest commit

0d55284 · Nov 23, 2018

History

12 Commits
Jul 6, 2018
Jul 6, 2018
Jun 1, 2018
Jun 1, 2018
Jul 6, 2018
Nov 23, 2018
Nov 23, 2018
Jul 6, 2018
Jul 6, 2018
Jun 1, 2018
Jul 6, 2018
Nov 23, 2018
Jul 6, 2018

Repository files navigation

jsonpointer-helpers Build Status codecov Code style: black

Helpers for JSON pointers described by RFC 6901.

Installation

$ pip install jsonpointer-helpers

Usage

>>> import jsonpointer_helpers as jp
>>>
>>> jp.build({'foo': {'bar': 42}})
{'/foo/bar': 42}
>>>
>>> jp.build_pointer(['foo', 'bar'])
'/foo/bar'
>>>
>>> jp.parse_pointer('/foo/bar')
['foo', 'bar']
>>>
>>> jp.escape_token('foo~bar')
'foo~0bar'
>>>
>>> jp.unescape_token('foo~0bar')
'foo~bar'
>>>

Contributing

To work on the jsonpointer-helpers codebase, you'll want to clone the project locally and install the required dependencies via poetry:

$ git clone git@github.com:Gr1N/jsonpointer-helpers.git
$ poetry install

To run tests and linters use command below:

$ poetry run tox

If you want to run only tests or linters you can explicitly specify which test environment you want to run, e.g.:

$ poetry run tox -e py37-tests

License

jsonpointer-helpers is licensed under the MIT license. See the license file for details.