Nirum: IDL compiler and RPC/distributed object framework for microservices
Haskell Python Shell
Switch branches/tags
Nothing to show
Latest commit 7853572 Jul 23, 2017 @dahlia dahlia committed on GitHub Merge pull request #154 from dahlia/union-tag-docs
Union tag docs now can be in parentheses

README.md

Nirum

Build Status (Travis CI) Build Status (AppVeyor) Docker Automated Build Total lines of code Gitter codecov

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

You can run the test suite of Nirum:

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

Related projects & tools

See also the list of Nirum-related projects on GitHub. Have you kicked off a new project related to Nirum? Please add nirum topic to your project on GitHub!

Editor supports

Language runtimes

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 (이영도).