/liboparl

GLib-based library for OParl client applications
  1. Vala 99.3%
  2. Shell 0.7%
Vala Shell
Find file
Latest commit 1ebde4e Dec 21, 2016 @grindhold grindhold object: can now handle vendor attributes
Permalink
Failed to load latest commit information.
examples Fixed script invocation Oct 29, 2016
src object: can now handle vendor attributes Dec 21, 2016
test object: can now handle vendor attributes Dec 21, 2016
.gitignore replace cmake with meson Sep 11, 2016
LICENSE added lgp Sep 4, 2016
README.md readme: added missing dependency Oct 7, 2016
build.macos Update build.macos Nov 18, 2016
fix_permissions.sh fix-permission script has prefix variable Sep 26, 2016
meson.build add revision info to meson.build & pkgconfig Nov 17, 2016
meson_options.txt + file header Oct 29, 2016
oparl-0.2.deps added a vala dependency file Sep 14, 2016

README.md

liboparl

You are laying eyes on liboparl. A client implementation of the OParl-1.0 specification. It's your easy way to access endpoints in a straightforward fashion.

Features

  • Parsing all OParl objects
  • Check syntactic spec conformity - types and fieldnames are correct
  • Check semantic spec conformity - values are realistic and make sense [ in progress ]

Meta-Features

  • Unittests
  • API-Documentation (GNOME Devhelp book format)
  • i18n

Characteristics

The library's objective is to abstract OParls object format away from you. You as someone who develops an application for OParl does not need to know how to resolve the ids that objects yield to you and how to parse the objects themselves and check them for correctness.

The library does not want to interfere with your way to write programs which is why liboparl leaves all non-OParl-related tasks to you. OParl exposes anything it needs from you through signals and interfaces. For example, if liboparl wants to request a new object via HTTP, it triggers the signal resolve_url that belongs to the OParl.Client-Object. This signal gives you an url and expects to get a JSON-string back. You can implement this method however you feel is right for your project. If you program liboparl in Python you could use requests. If you program liboparl in Perl, you could use LWP. This also gives you the possibility to handle multithreading as you wish. And the best thing: liboparl can provide an API that is as clean and uncluttered as possible.

As mentioned before, liboparl is a GObject-based library. This means that you can use it in any programming language that supports GObject-Introspection. Famous examples are e.g. Python Ruby or Lua. Check if your favoured language is available at GObjectIntrospecion

Dependencies

The following libraries have to be present for liboparl to run:

  • glib-2.0
  • json-glib-1.0

Building

Meson is used as the buildsystem for liboparl. The build dependencies are the following:

  • valac - Vala compiler
  • valadoc - Vala documentation tool
  • g-ir-compiler - GObject introspection compiler
  • json-glib-dev - Dev headers for json-glib
  • libgirepository1.0-dev - Dev headers for gobject introspection

Clone and build the library as follows:

$ git clone https://github.com/oparl/liboparl
$ cd liboparl
$ mkdir build
$ cd build
$ meson ..
$ ninja

If you desire to install the library, execute:

# ninja install

Running the examples

liboparl supports GObject-Introspection which means you can consume it in various popular languages including but not limited to: Python, Perl, Lua, JS, PHP. I compiled some examples on how to program against the library in Python in the examples-folder.

Feel free to add examples for your favorite language.

Note: If you installed the library in /usr/local, you have to export the following environment variables for the examples to work:

$ export LD_LIBRARY_PATH=/usr/local/lib 
$ export GI_TYPELIB_PATH=/usr/local/lib/girepository-1.0/