https://github.com/gr1n/jsonpointer-helpers

Helpers for JSON pointers described by RFC 6901
https://github.com/gr1n/jsonpointer-helpers

helpers json jsonpointer rfc-6901 rfc6901 utils

Last synced: 3 months ago
JSON representation

Helpers for JSON pointers described by RFC 6901

• Host: GitHub
• URL: https://github.com/gr1n/jsonpointer-helpers
• Owner: Gr1N
• License: mit
• Created: 2018-06-01T10:47:24.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-11-23T13:53:51.000Z (over 6 years ago)
• Last Synced: 2025-02-20T18:47:11.389Z (3 months ago)
• Topics: helpers, json, jsonpointer, rfc-6901, rfc6901, utils
• Language: Python
• Homepage: https://pypi.org/project/jsonpointer-helpers/
• Size: 19.5 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jsonpointer-helpers [![Build Status](https://travis-ci.org/Gr1N/jsonpointer-helpers.svg?branch=master)](https://travis-ci.org/Gr1N/jsonpointer-helpers) [![codecov](https://codecov.io/gh/Gr1N/jsonpointer-helpers/branch/master/graph/badge.svg)](https://codecov.io/gh/Gr1N/jsonpointer-helpers) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

Helpers for JSON pointers described by [RFC 6901](https://tools.ietf.org/html/rfc6901).

## 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](https://poetry.eustace.io):

    $ git clone [email protected]: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.