README.md 1.16 KB
Newer Older
dmitry's avatar
dmitry committed
1 2 3
### Biotools Populous is a utility to push biotools data into a git repository.

The utility is based on modified version of [JGit](https://github.com/redmitry/jgit) libarary based on [NIO2](https://jcp.org/en/jsr/detail?id=203) API and 
dmitry's avatar
dmitry committed
4
[Jimfs](https://github.com/google/jimfs) in-memory file system. It allows wirking with git repositories directly, without writing anything on a disk.
dmitry's avatar
dmitry committed
5 6 7 8 9 10 11 12 13 14 15 16 17

To get tools data, utility uses the Biotools REST API (https://bio.tools/api/tool/).
Generated files are in JSON format inferred from [biotoolsSchema 3.1](https://github.com/bio-tools/biotoolsSchema).

Compiling:
```shell
>git clone https://gitlab.bsc.es/inb/elixir/tools-platform/biotools-git-populous.git
>cd biotools-git-populous
>mvn install
```

It will create **biotools-populous.jar** file in the **biotools-git-populous/target/** directory.

dmitry's avatar
dmitry committed
18
Running:
dmitry's avatar
dmitry committed
19 20 21 22 23 24 25 26 27 28 29 30
```shell
>java -jar biotools-populous.jar -g https://gitlab.bsc.es/xyz -u user -p password --path /biotools
```

where:

* -h         - help
* --git      - git repository to push tools json files
* --branch   - remote branch to push
* --path     - remote path to put files
* --user     - git user name
* --password - git user password