Giter VIP home page Giter VIP logo

jmespath.cpp's Introduction

jmespath.cpp

Build Status Build status Coverage Status MIT license

jmespath.cpp is a C++ implementation of JMESPath, a query language for JSON. It can be used to extract and transform elements of a JSON document.

JMESPath expression example

Input JSON document:

{
  "locations": [
    {"name": "Seattle", "state": "WA"},
    {"name": "New York", "state": "NY"},
    {"name": "Bellevue", "state": "WA"},
    {"name": "Olympia", "state": "WA"}
  ]
}

JMESPath expression:

locations[?state == 'WA'].name | sort(@) | {WashingtonCities: join(', ', @)}

Result of evaluating the expression:

{"WashingtonCities": "Bellevue, Olympia, Seattle"}

For more examples take a look at the JMESPath Tutorial or the JMESPath Examples pages.

Usage

To use the public functions and classes of jmespath.cpp you should include the header file #include <jmespath/jmespath.h>. The public interface is declared in the jmespath namespace.

#include <iostream>
#include <jmespath/jmespath.h>

namespace jp = jmespath;

int main(int argc, char *argv[])
{
    auto data = R"({
        "locations": [
            {"name": "Seattle", "state": "WA"},
            {"name": "New York", "state": "NY"},
            {"name": "Bellevue", "state": "WA"},
            {"name": "Olympia", "state": "WA"}
        ]
    })"_json;
    jp::Expression expression = "locations[?state == 'WA'].name | sort(@) | "
                                "{WashingtonCities: join(', ', @)}";
    std::cout << jp::search(expression, data) << std::endl;
    return 0;
}

Documentation

http://robertmrk.github.io/jmespath.cpp

Install

Requirements

To build, install and use the library you must have CMake installed, version 3.8 or later.

Supported compilers

jmespath.cpp needs a compiler that supports at least the c++14 standard. The currently supported and tested compilers are:

  • g++ versions: 6, 7, 8
  • Clang versions: 4.0, 5.0, 6.0, 7
  • XCode versions: 9.0, 9.3, 10.1
  • Visual Studio 2017

Library dependencies

Install from source

Build and install

To get the source code of the library either clone it from github

git clone https://github.com/robertmrk/jmespath.cpp.git

or download the latest release and extract it.

In the terminal change the current directory to the location of the source code

cd <path_to_source>/jmespath.cpp

Generate the project or makefiles for the build system of your choice with CMake, then build and install the library:

mkdir build
cd build
cmake .. -G"Unix Makefiles" -DCMAKE_BUILD_TYPE=Release -DJMESPATH_BUILD_TESTS=OFF
sudo cmake --build . --target install

Integration

To use the library in your CMake project you should find the library with find_package and link your target with jmespath::jmespath:

cmake_minimum_required(VERSION 3.8)
project(example)

find_package(jmespath 0.1.0 CONFIG REQUIRED)

add_executable(${PROJECT_NAME} main.cpp)
target_link_libraries(${PROJECT_NAME} jmespath::jmespath)
target_compile_features(${PROJECT_NAME} PUBLIC cxx_std_14)

Install with Conan

If you are using Conan to manage your dependencies, then add jmespath.cpp/x.y.z@robertmrk/stable to your conanfile.py's requires, where x.y.z is the release version you want to use.

Please file issues here if you experience problems with the packages.

jmespath.cpp's People

Contributors

robertmrk avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.