IBM/wcs-ocaml

Name: wcs-ocaml

Owner: International Business Machines

Description: Watson Conversation Service OCaml SDK

Created: 2017-07-17 19:07:21.0

Updated: 2018-04-30 13:59:54.0

Pushed: 2018-03-07 15:30:22.0

Homepage: https://ibm.github.io/wcs-ocaml/

Size: 528

Language: OCaml

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

SDK and command line interface for Watson Conversation Service

wcs-ocaml is a source development kit in OCaml and command line interface for Watson Conversation Service (WCS). It allows to program chat bots in OCaml.

• wcs-lib provides a framework to write WCS programs, called workspaces.
• wcs-api offers an OCaml binding to the service API and a generic client application.
• wcs is a command line tool that interact with the service.

The documentation is available online or in the directory docs.

Install

Quick install with Opam

You can install wcs-ocaml with the following command:

 install wcs

This will install the three main packages:

• wcs-lib,
• wcs-api and,
• wcs

Install from source with Opam

Opam can also be used to compile and install from the source directory. For that you first need to pin the source directory. So, from this directory, do:

 pin add wcs-lib .
 pin add wcs-api .
 pin add wcs .

Then you can install using the command:

 install wcs

If the source files are modified, the packages must be reinstalled with the command:

 reinstall wcs-lib

Building from source

Prerequistes

To build from source, you will need to install the dependencies listed in the depends field of the *.opam files.

An easy way to get set up on most platforms is to use the OCaml package manager (https://opam.ocaml.org). Once opam is installed, you can just add the corresponding libraries:

 install ocamlfind sedlex menhir rml ...

Compiling

To compile, do:

Make a new release

In order to do a new release, we have to do the following steps.

1. Make sure that the documentation is up to date:

    webdoc
   

2. Search and update the version number:

    -r -e '\d\d\d\d-\d\d-\d\d.\d\d-dev' .
   

3. Update the CHANGES.md file.

4. Create a new release on the github interface: https://github.com/IBM/wcs-ocaml/releases

5. Create a new release of the opam packages.

6. Create or update the fork of https://github.com/ocaml/opam-repository

   checkout master
   fetch --all
   merge --ff-only upstream/master
   push
   

7. Create a new branch

   checkout -b wcs-XXXX-XX-XX.XX
   

8. Create the new packages from the old ones:

   R packages/wcs-lib/wcs-lib.YYYY-YY-YY.YY packages/wcs-lib/wcs-lib.XXXX-XX-XX.XX
   R packages/wcs-api/wcs-api.YYYY-YY-YY.YY packages/wcs-api/wcs-api.XXXX-XX-XX.XX
   R packages/wcs/wcs.YYYY-YY-YY.YY packages/wcs/wcs.XXXX-XX-XX.XX
   

9. Update the opam files:

   CS_OCAML_DIR/wcs-lib.opam packages/wcs-lib/wcs-lib.XXXX-XX-XX.XX/opam
   CS_OCAML_DIR/wcs-api.opam packages/wcs-api/wcs-api.XXXX-XX-XX.XX/opam
   CS_OCAML_DIR/wcs.opam packages/wcs/wcs.XXXX-XX-XX.XX/opam
   

10. Update the url files

    s packages/wcs-lib/wcs-lib.XXXX-XX-XX.XX/url
    ackages/wcs-lib/wcs-lib.XXXX-XX-XX.XX/url packages/wcs-api/wcs-api.XXXX-XX-XX.XX/url
    ackages/wcs-lib/wcs-lib.XXXX-XX-XX.XX/url packages/wcs/wcs.XXXX-XX-XX.XX/url
    

11. Commit and push the changes

    push origin wcs-XXXX-XX-XX.XX
    

12. Create a pull request from the github interface: https://github.com/ocaml/opam-repository

13. Once the pull request is accepted update the version number.

Contribute

Contributions and bug reports are welcome! To contribute please follows the instructions given in the file (CONTRIBUTING.md)[./CONTRIBUTING.md].