The harmony package

[ Tags: development, gpl, library, program ] [ Propose Tags ]

A parser of web service specification that is able to generate servers, clients and tests.


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.1.0 (info)
Dependencies array, base (>=4.6 && <5), BNFC, containers, derive, directory, harmony, hastache, hslogger, mtl, process, QuickCheck, text [details]
License GPL-3
Author Santiago Munín
Maintainer santimunin@gmail.com
Category Development
Bug tracker https://github.com/SantiMunin/harmony/issues
Source repository head: git clone https://github.com/SantiMunin/harmony
Uploaded Wed Aug 19 06:41:53 UTC 2015 by SantiMunin
Distributions NixOS:0.1.1.0
Executables harmony
Downloads 536 total (8 in the last 30 days)
Rating 2.0 (1 ratings) [clear rating]
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2015-08-19 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for harmony-0.1.1.0

[back to package description]

Harmony Hackage version Build Status

Harmony is a web service specification compiler that generates implementation (server and client) and tests.

Targets supported

  • Server
    • Node.js (-sjs)
  • Client
    • Python (-cpython)
    • Java (-cjava)

Installation

  • From Hackage: cabal install harmony
  • From source code: git clone https://www.github.com/SantiMunin/harmony && cd harmony && cabal install

Usage

After installing the package (cabal install), you will get the harmony executable. Afterwards:

Usage: harmony [OPTION...] input_file
  -c[CLIENTS]     --client[=CLIENTS]         Desired output for the client: {-cpython, -cjava}
  -s[SERVERS]     --server[=SERVERS]         Desired output for the server: {-sjs}
  -o[OUTPUT_DIR]  --output_dir[=OUTPUT_DIR]  Output path

Check the Targets supported section to figure out the code related to each target. Also, refer to the wiki for more information.

Syntax

The input file should follow the syntax specified in language_spec/Language.cf. Example:

service_name: HouseworkService
service_version: 1.0.0

enum Color { RED, BLUE, BLACK }

struct Task {
   // Primary key
   @PK
   name : String,
   color : Color
}

struct Person {
  name: String,
  age: Int,
  tasks: [Task]
}

resource Person ("/person")

Contributing

See the wiki.