Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

JSON Pointer helpers

Project description

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'
>>>

Testing and linting

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
jsonpointer_helpers-0.2.0-py3-none-any.whl (4.7 kB) Copy SHA256 hash SHA256 Wheel py3
jsonpointer-helpers-0.2.0.tar.gz (3.0 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page