commonwealthrobotics / bowler-script-kernel Goto Github PK

View Code? Open in Web Editor NEW

7.0 3.0 3.0 298.38 MB

The CLI and API layer for the Bowler ScriptingEngine and all its dependant libraries.

License: GNU Lesser General Public License v3.0

Groovy 0.19% Java 99.64% Shell 0.17%

bowler-script-kernel's Introduction

Documentation

Javadoc Generated Documentation

Bowler Kernel Scripting environment

This is the core kernel mechanism for the Bowler operating system. It consists of a modular scripting environment. This engine passes Lists of JVM objects back and forth across languages, letting you mix Java, Groovy, Clojure and Python within a single memory sharing application. The sources are stored in git repos and hyperlink at the source level to add modules. You can call this application from the command line like bash and pass it scripts to run sequentially or pipe the output from one into the input of another.

All platforms

You need to use the installer from

BowlerStudio Installer

Usage

This will let you pass code snippets directly to the scripting engine

Object returnVal = ScriptingEngine.inlineScriptRun(String code, ArrayList<Object> args,ShellType activeType)

This will let you load code directly out of a github gist: This code will load this github gist: https://gist.github.com/madhephaestus/d4312a0787456ec27a2a

Object returnVal = ScriptingEngine.inlineGistScriptRun("d4312a0787456ec27a2a", "helloWorld.groovy" ,null)

Embed as a library in your projects

Maven

<dependency>
  <groupId>com.neuronrobotics</groupId>
  <artifactId>BowlerScriptingKernel</artifactId>
  <version>VERSION_FROM_BADGE</version>
</dependency>

Gradle

dependencies {
 compile "com.neuronrobotics:BowlerScriptingKernel:VERSION_FROM_BADGE"
}

All platforms

  Usage: 
  
  java -jar BowlerScriptKernel.jar -s .. # This will load one script after the next

  java -jar BowlerScriptKernel.jar -p .. # This will load one script then take the list of objects returned and pass them to the next script as its 'args' variable
  
  java -jar BowlerScriptKernel.jar -r <Groovy,Clojure,Jython> #Starts a repl for interactive robot coding
  
  java -jar BowlerScriptKernel.jar -g <GIT url>  <File> # Runs a file from its git location

bowler-script-kernel's People

Contributors

Stargazers

Watchers

Forkers

octogonapus rohankumardubey rossturner

bowler-script-kernel's Issues

How to build & see static analysis violations

Building

I have been putting this work on branches named refactor_build_script. The kernel and its two submodules have a branch named that. Check it out, initialize & update the submodules, and then run gradlew classes to compile things (note that this only compiles the main source set, to compile the test source set run gradlew testClasses).

Running the analysis

gradlew tasks prints out all the tasks runnable from the root project. The tasks you should be concerned about for now are:

gradlew findbugsMain runs the FindBugs static analysis tool.
gradlew pmdMain runs the PMD static analysis tool.
gradlew checkstyleMain runs the Checkstyle format checker.
gradlew spotlessCheck and gradle spotlessApply runs the Spotless format checker and formatter. spotlessCheck prints out formatting violations, if there are any, and spotlessApply fixes all the violations it can and will print out those that it can't.

Most of those tasks above have a Main suffix. This means that they will run on the "main" source set. Essentially, this is all your code minus tests. To run those tools on test sources, use a Test suffix instead. For example, gradlew pmdMain runs on the main source set and gradlew pmdTest runs on the test source set.

These tools have various ways of telling you that you are a bad programmer. FindBugs prints violations into your terminal, and I believe Checkstyle does as well (though you shouldn't have much, or any, trouble with Checkstyle if you just run gradlew spotlessApply first). PMD prefers to save reports to a file, which it will link to you in your terminal.

commonwealthrobotics / bowler-script-kernel Goto Github PK

bowler-script-kernel's Introduction

Documentation

Bowler Kernel Scripting environment

All platforms

Usage

Embed as a library in your projects

Maven

Gradle

All platforms

bowler-script-kernel's People

Contributors

Stargazers

Watchers

Forkers

bowler-script-kernel's Issues

Building

Running the analysis

Recommend Projects

Recommend Topics

Recommend Org