npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

apibone

v0.0.25

Published

Abstracts requests and responses to make them platform agnostic

Downloads

67

Readme

apibone

npm version npm download dependencies license

apibone is a library which provides some interfaces for queryable services. It simply abstracts request and response objects for its defined functions.

apibone modules query various web services and return responses in requested formatting. Whether the platform is cli or web, modules access same interface for input and output objects.

Queries

Apibone breaks queries in three parts:

  • Module name / alias
  • Arguments
  • Parameters

in command line form:

module [arguments ...] [--parameter value ...]

For example, to execute rates module in order to query 5 USD's TRY value:

$ apibone module rates usd try --amount 5 # cli example
http://example.com/rates/usd/try?amount=5 # web example

module: module name which will be called. (e.g.: rates)
arguments: arguments of operation (e.g.: first argument is usd, second argument is try)
parameters: optional settings for operation (e.g.: amount with value 5)

Installation

$ npm install -g apibone
$ mv config.sample.js config.js # rename config.sample.js to config.js

CLI Usage

$ apibone module [arguments]

# Examples:
$ apibone modules
$ apibone rates usd try
$ apibone rates usd try --amount 5
$ apibone weather izmir
$ apibone test anyCommand --anyParam=anyValue --anyOptionalParam

REPL Usage

$ apibone

apibone> modules
apibone> weather izmir
apibone> /q

Web Usage

$ npm start

# Example:
http://localhost:3000/modules
http://localhost:3000/rates/usd/try?amount=5
http://localhost:3000/weather/izmir
http://localhost:3000/test/anyCommand?anyParam=anyValue&anyOptionalParam&format=text

Start as a Telegram Bot

$ node ./lib/telegrambot.js

Start as a Slack Bot

$ node ./lib/slackbot.js

Modules

  • Salyangoz (http://salyangoz.me)
  • Rates
  • Weather (http://openweathermap.org)
  • Def
  • Speech (https://translate.google.com/)

Requirements

  • node.js (https://nodejs.org/)

License

MIT, for further details, please see LICENSE file.

Contributing

See contributors.md

It is publicly open for any contribution. Bugfixes, new features and extra modules are welcome.

  • To contribute to code: Fork the repo, push your changes to your fork, and submit a pull request.
  • To report a bug: If something does not work, please report it using GitHub issues.
  • To support: Donate