Code Monkey home page Code Monkey logo

librarian-api's Introduction

librarian-api

Build Status Coverage Status Dependency Status

Client library for the libraries.io api.

Install

$ npm install --save librarian-api

New since version 0.2.0

Pagination

Paging is now supported with the page and per_page query parameters. You can also obtain the raw request response passing the raw: true option.

Please refer to test.js for usage examples.

Rate limits

All queries are now limited to 10 per 10 seconds.

New since version 0.1.0

The cli now uses update-notifier to let the user know about updates to this program.

Users have the ability to opt-out of the update notifier by changing the optOut property to true in ~/.config/configstore/update-notifier-rollodeqc-gh-user-streak.json. The path is available in notifier.config.path.

Users can also opt-out by setting the environment variable NO_UPDATE_NOTIFIER with any value or by using the --no-update-notifier flag on a per run basis.

Usage

const librarianApi = require('librarian-api');

librarianApi('unicorns');
//=> 'unicorns & rainbows'

Environment variables

You'll need a token from https://libraries.io/account to call the API.

Define it as an environment variable:

export LIBRARIES_IO_TOKEN=abcd1234...

If you use another instance of libraries.io, you can define it the same way:

export LIBRARIES_IO_ENDPOINT=http://example.com/api

Otherwise https://libraries.io/api is used.

API

API Docs: https://libraries.io/api

librarianApi.search(query)

query

Type: string

Lorem ipsum.

librarianApi.platform(platform, name)

platform

Type: string

name

Type: string

Lorem ipsum.

librarianApi.platform.dependencies(platform, name, version)

platform

Type: string

name

Type: string

version

Type: string

Lorem ipsum.

librarianApi.platform.dependents(platform, name)

platform

Type: string

name

Type: string

Lorem ipsum.

librarianApi.platform.dependent_repositories(platform, name)

platform

Type: string

name

Type: string

Lorem ipsum.

librarianApi.github(owner, name)

owner

Type: string

name

Type: string

Lorem ipsum.

librarianApi.github.dependencies(owner, name)

owner

Type: string

name

Type: string

Lorem ipsum.

librarianApi.github.projects(owner, name)

owner

Type: string

name

Type: string

Lorem ipsum.

CLI

$ npm install --global librarian-api
$ librarian-api --help

  Usage
    librarian-api [input]

  Options
    --foo  Lorem ipsum. [Default: false]

  Examples
    $ librarian-api
    unicorns & rainbows
    $ librarian-api ponies
    ponies & rainbows

License

AGPL-v3 © Robin Millette

librarian-api's People

Contributors

millette avatar zeke avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.