Nirum: IDL compiler and RPC/distributed object framework for microservices
Clone or download
Permalink
Failed to load latest commit information.
app Add anchor links to headings Aug 17, 2018
docs
examples Fix typo in shapes.nrm Aug 17, 2018
src/Nirum Merge tag '0.4.2' Aug 24, 2018
test
.dockerignore Fix Docker build & use Alpine w/ multi-stage build Feb 13, 2018
.editorconfig
.gitignore fix double lining for empty elements Aug 17, 2018
.hadolint.yaml
.hlint.yaml Upgrade to Stackage LTS Haskell 12.0 Jul 11, 2018
.travis.yml Merge branch '0.4-maintenance' into 0.5-maintenance Aug 25, 2018
CHANGES.md
CONTRIBUTING.md Merge branch '0.4-maintenance' Aug 14, 2018
Dockerfile Fix Shellcheck and Hadolint [changelog skip] Aug 13, 2018
LICENSE Initial commit --- working in progress May 10, 2016
README.md Version bump 0.5.1 Aug 24, 2018
Setup.hs Initial commit --- working in progress May 10, 2016
appveyor.yml Merge branch '0.4-maintenance' Aug 14, 2018
bitbucket-pipelines.yml Test on Bitbucket Pipelines Aug 17, 2017
codecov.yml Fix code cov (#156) Feb 12, 2018
docker-entrypoint.sh Moved the Git repository Aug 14, 2018
lint.hs Upgrade to Stackage LTS Haskell 10.7 (#240) Mar 3, 2018
lint.sh Fix Shellcheck and Hadolint [changelog skip] Aug 13, 2018
package.yaml Merge branch '0.4-maintenance' into 0.5-maintenance Aug 25, 2018
stack.yaml Upgrade to Stackage LTS Haskell 12.2 Jul 23, 2018
tox.ini Update tox.ini file envlist with python 3.7 Aug 15, 2018

README.md

Nirum

The latest release on GitHub Docker automated build Build status on Linux and macOS (Travis CI) Build status on Windows (AppVeyor) Test coverage (codecov) Total lines of code 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 the language 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.

Installation

The Nirum compiler works on the most major platforms like Linux, macOS, and Windows. We provide the prebuilt executable binaries for these three platforms.

Released builds

You can download executable binaries for Linux (x86_64), macOS (x86_64), or Windows (x64) from the latest release note. You should give it appropriate permissions (e.g., +x) depending on your platform.

If you look for a previous release, see the list of all releases.

We provide official Docker images as well. You can check the list of released tags. Note that latest is for a nightly build which is unstable (see below).

Nightly builds

Since Nirum is still changing by leaps and bounds, you could want to try its bleeding edge. We provide nightly builds for this purpose.

Although we call it "nightly build," technically it is not built every night, but done every merge commit.

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 information, 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.5.1

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

There is a step-by-step tutorial as well.

Building

If you already installed Haskell Stack, you can build the project in the same way to build other Haskell softwares:

$ stack build

You can run the test suite of Nirum:

$ stack test  # unit test for compiler
$ ./lint.sh   # style lint

For details, please read the contribution guide.

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!

Language runtimes

Editor supports

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