README.md

jteuton

All-in-one Java wrapper for teuton Ruby gem (using JRuby).

Using jteuton library with Maven

<dependency>
    <groupId>io.github.teuton-software</groupId>
    <artifactId>jteuton</artifactId>
    <version>{jteuton.version}</version>
</dependency>

Using jteuton library with Gradle

implementation 'io.github.teuton-software:jteuton:{jteuton.version}'

How to compile and install jteuton to your local Maven repo

Clone the repo and change to its directory:

git clone https://github.com/teuton-software/jteuton.git
cd jteuton

Download and install Ruby gems (teuton and teuton-get) into src/main/resources:

mvn exec:exec@install-rubygems

Build, package and install the JAR library into your local Maven repo:

mvn install

Upgrade Ruby gems

jteuton depends on some Ruby gems: teuton and teuton-get.

Install Ruby gems

mvn exec:exec@install-rubygems

Uninstall Ruby gems

mvn clean:clean@uninstall-rubygems

Also deletes targetdirectory.

Reload all Ruby gems

mvn clean:clean@uninstall-rubygems exec:exec@install-rubygems

Usage examples:

teuton

Import Teuton class:

import io.github.teuton.Teuton;

Get version

Code:

System.out.println(Teuton.execute("version"));

or

System.out.println(Teuton.version());

Output:

X.Y.Z

Get help

Code:

System.out.println(Teuton.execute("help"));

Output:

Commands:
  teuton [run] [OPTIONS] DIRECTORY  # Run challenge from directory
  teuton check [OPTIONS] DIRECTORY  # Test or check challenge contents
  teuton help [COMMAND]             # Describe available commands or one spec...
  teuton new DIRECTORY              # Create skeleton for a new project
  teuton readme DIRECTORY           # Create README.md file from challenge co...
  teuton version                    # Show the program version

teuton-get

Import TeutonGet class:

import io.github.teuton.TeutonGet;

Get version

Code:

System.out.println(TeutonGet.execute("version"));

or

System.out.println(TeutonGet.version());

Output:

X.Y.Z