{
"info": {
"author": "SciJava team",
"author_email": "ctrueden@wisc.edu",
"bugtrack_url": null,
"classifiers": [],
"description": "[](https://github.com/scijava/jgo/actions/workflows/build.yml)\n[](https://github.com/psf/black)\n\n# jgo: painless Java component execution\n\n\n\n## Summary\n\n[Maven](https://maven.apache.org/) is a great tool. It manages dependencies so\nthat Java projects become reusable \"building blocks\" in a robust way, like\n`pip` for Python, `npm` for JavaScript, `gem` for Ruby, `cpan` for Perl, etc.\nAnd the [Maven Central repository](https://search.maven.org/) contains a\ntremendous wealth of code, ripe for reuse in your own projects.\n\nUnfortunately, Maven provides no easy way to actually __launch code__ from the\nbeautifully managed dependencies stored so lovingly into `~/.m2/repository`.\n\nThis project fills that gap: `jgo` launches Java code. You do not need to\ndownload or install any JARs; you just specify an \"endpoint\" consisting of a\n[Maven artifact](https://stackoverflow.com/a/2487511/1207769) identifier, plus\na main class if needed/desired, and `jgo` uses Maven to obtain and run it.\n\nTo do this, `jgo` builds the local environment on demand, caching it into a\nsubfolder of `~/.jgo`, so that the endpoint's particular dependencies are\navailable in one place.\n\n## Installation\n\nThe `jgo` project began life as a shell script, but was later translated into\nPython, so that tools such as [scyjava](https://github.com/scijava/scyjava)\ncould leverage its environment-building capabilities.\n\nAs such, there are now two implementations from which to choose!\nEach has pros and cons.\n\n### Prerequisites\n\n`jgo` uses `mvn` and `java` for the heavy lifting.\nThe shell script version needs some common utilities (e.g., `cat`).\nIf you are missing anything, the script will tell you.\n\n### The shell script\n\nThe `jgo.sh` shell script requires a POSIX-friendly system. It is known to\nwork on Linux, macOS, [Cygwin](https://www.cygwin.com/), Microsoft's\n[Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install),\nand Git BASH from the [Git for Windows](https://git-for-windows.github.io/) project.\n\nInstalling the shell script
\n\nJust clone this repo and symlink `jgo.sh` into your favorite `bin` directory.\n\nFor example, assuming `~/bin` is on your PATH:\n\n```shell\ncd\ngit clone https://github.com/scijava/jgo\ncd bin\nln -s ../jgo/jgo.sh jgo\njgo --help\n```\n\nInstalling with pip
\n\n```shell\npip install jgo\n```\n\nInstalling with conda
\n\n```shell\nconda install -c conda-forge jgo\n```\n\nInstalling from source
\n\n```shell\ngit clone https://github.com/scijava/jgo\ncd jgo\n\n# install globally (not recommended unless using a virtual environment)\npip install .\n\n# install into ~/.local (see pip install --help for details)\npip install --user .\n\n# install into $PREFIX\npip install --prefix=$PREFIX .\n\n# install globally in developer mode (hot linked to working copy folder)\npip install -e .\n```\n\n