IDL compiler and RPC/distributed object framework for microservices
Haskell Python Shell
Latest commit b134a67 Mar 25, 2017 @dahlia dahlia committed on GitHub Merge pull request #33 from dahlia/compatibility-docs
Backward compatibile refactoring guide

README.md

Nirum

Build Status (Travis CI) Build Status (AppVeyor) Docker Automated Build Gitter

Nirum is an IDL compiler and RPC/distributed object framework for microservices, built on top of the modern Web server technologies such as RESTful HTTP and JSON.

You can find how its IDL looks like from source codes in the examples/ directory.

Note that its design is highly unstable and could be changed. Also the feature set is incomplete yet.

Nightly builds

The easiest way to give a try to use Nirum is downloading a nightly build. We currently provides the prebuilt binaries of the following platforms:

Getting started

In order to compile a Nirum package (examples/) to a Python package:

$ mkdir out/  # directory to place generated Python files
$ nirum -t python -o out/ examples/

For more infomration, use --help option:

$ nirum --help
Nirum: The IDL compiler and RPC/distributed object framework

Usage: nirum [-v|--version] (-o|--output-dir DIR) (-t|--target TARGET) DIR
  Nirum compiler 0.3.0

Available options:
  -h,--help                Show this help text
  -v,--version             Show version
  -o,--output-dir DIR      Output directory
  -t,--target TARGET       Target language name. Available: docs, python
  DIR                      Package directory

Building

If you already installed Haskell Platform or Haskell Stack, you can build the project in the same way to build other Haskell projects.

Using Haskell Stack:

$ stack build

Using vanilla Cabal:

$ cabal sandbox init
$ cabal install --only-dependencies
$ cabal configure
$ cabal build

You can run the test suite of Nirum:

$ stack test  # using Hasekll Stack
$ cabal test  # using Haskell Platform
$ ./lint.sh   # run style lint as well

Etymology

니름 (IPA: /niɾɯm/; nireum) is a sort of telepathy in the fictional world of The Bird That Drinks Tears (눈물을 마시는 새 Nunmureul masineun sae) by Lee Yeongdo (이영도).