masnagam/njtool

# njtool

> Tool for nature.com users

[![npm](https://img.shields.io/npm/v/njtool)](https://www.npmjs.com/package/njtool)
[![CI](https://github.com/masnagam/njtool/workflows/CI/badge.svg)](https://github.com/masnagam/njtool/actions?query=workflow%3ACI)
[![Maintainability](https://api.codeclimate.com/v1/badges/520d222651cf6841a61d/maintainability)](https://codeclimate.com/github/masnagam/njtool/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/520d222651cf6841a61d/test_coverage)](https://codeclimate.com/github/masnagam/njtool/test_coverage)

`njtool` provides useful commands to operate on www.nature.com with [Puppeteer].

## How to use

A command below fetches PDF files of articles in "Nature Volume 555 Issue 7694",
and saves them into /journals/nature/555/7694:

```console
$ njtool scrape journal nature:555:7694 | \
    njtool download -u your@email.address -p your_password -o /journals
```

You can use the following environment variables instead of specified options in
`download` subcommand:

* `NJTOOL_NATURE_USERNAME`
* `NJTOOL_NATURE_PASSWORD`
* `NJTOOL_NATURE_OUTDIR`

```console
$ cat .envrc
export NJTOOL_NATURE_USERNAME="your@email.address"
export NJTOOL_NATURE_PASSWORD="your_password"
export NJTOOL_NATURE_OUTDIR="/journals"

$ njtool scrape journal nature:555:7694 | njtool download
```

Downloading multiple journals are supported:

```console
$ njtool scrape journal nature:555:7695 nature:555:7696 | \
    njtool download
```

Downloading journals of specific volumes:

```console
$ njtool scrape volume --only-ids nature:555 nature:556 | \
    njtool scrape journal | njtool download
```

At this moment, `njtool` supports only Nature.  I have no plan to support other
journals.  Because I have no plan to subscribe others.

`njtool` works fine on macOS, Linux and Windows.

It's recommended for macOS users to use `caffeinate` in order to prevent the
system from sleeping when you run `njtool download` which typically takes a long
time.

```console
$ njtool scrape journal nature:555:7697 | caffeinate -i njtool download ...
```

Linux users may need to run commands with the `--no-sandbox` option.

See help for details of each command:

```console
$ njtool help
```

## License

This software is distributed under the MIT license.  See [LICENSE] file for
details.

[Puppeteer]: https://github.com/GoogleChrome/puppeteer
[LICENSE]: ./LICENSE