Skip to content

Commit

Permalink
prepare to publish on npm
Browse files Browse the repository at this point in the history
  • Loading branch information
bmesuere committed Aug 7, 2024
1 parent 0dd1b12 commit e66da23
Show file tree
Hide file tree
Showing 3 changed files with 1,538 additions and 30 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,33 @@
# unipept-cli

[![Gem Version](https://badge.fury.io/rb/unipept.svg)](http://badge.fury.io/rb/unipept)
![NPM Version](https://img.shields.io/npm/v/unipept-cli)

Unipept-cli offers a command line interface to the [Unipept](http://unipept.ugent.be) web service.
Documentation about the web service can be found at [http://unipept.ugent.be/apidocs](http://unipept.ugent.be/apidocs), documentation about the command line tools at [http://unipept.ugent.be/clidocs](http://unipept.ugent.be/clidocs).

## Installation

To use the Unipept CLI, Ruby version 2.7 or higher needs to be installed. You can check this by running `ruby -v` on the commandline:
To use the Unipept CLI, node 22 or higher needs to be installed. You can check this by running `node -v` on the commandline:

```
$ ruby -v
ruby 3.0.0p0 (2020-12-25 revision 95aff21468) [arm64-darwin21]
$ node -v
v22.3.0
```

More information on installing Ruby can be found at https://www.ruby-lang.org/en/installation/
More information on installing Ruby can be found at https://nodejs.org/en/download/package-manager

The Unipept CLI is available as a _gem_. This means it can easily be installed with the following command:
The Unipept CLI is available as an npm package. This means it can easily be installed with the following command:

```bash
$ gem install unipept
Successfully installed unipept-1.0.1
Parsing documentation for unipept-1.0.1
Done installing documentation for unipept after 0 seconds
1 gem installed
$ npm install -g unipept-cli
added 3 packages in 986ms
```

After successful installation, the unipept command should be available:

```bash
$ unipept -v
1.0.1
4.0.0
```

The help can be accessed by running `unipept -h`.
14 changes: 9 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"name": "unipept-cli",
"version": "4.0.0",
"version": "4.0.0-1",
"description": "Command line interface to the Unipept web services",
"repository": "[email protected]:unipept/unipept-cli.git",
"author": "Bart Mesuere <[email protected]>",
"license": "MIT",
"private": false,
"type": "module",
"bin": {
"peptfilter": "./bin/peptfilter.js",
"prot2pept": "./bin/prot2pept.js",
"unipept": "./bin/unipept.js",
"uniprot": "./bin/uniprot.js"
"peptfilter": "./dist/bin/peptfilter.js",
"prot2pept": "./dist/bin/prot2pept.js",
"unipept": "./dist/bin/unipept.js",
"uniprot": "./dist/bin/uniprot.js"
},
"scripts": {
"build": "yarn run tsc",
Expand All @@ -23,6 +23,9 @@
"unipept": "yarn run tsx bin/unipept.ts",
"uniprot": "yarn run tsx bin/uniprot.ts"
},
"files": [
"dist"
],
"dependencies": {
"commander": "^12.1.0",
"csv-stringify": "^6.5.0"
Expand All @@ -37,6 +40,7 @@
"globals": "^15.6.0",
"jest": "^29.7.0",
"mock-stdin": "^1.0.0",
"np": "^10.0.7",
"ts-jest": "^29.1.5",
"ts-node": "^10.9.2",
"tsx": "^4.15.6",
Expand Down
Loading

0 comments on commit e66da23

Please sign in to comment.