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

github-contents

v0.0.1

Published

Get the contents of a file on github

Downloads

2

Readme

github-contents

Gets the contents of a file from a public Github repo using the github API.

installation

npm install github-contents

example usage

var getContents = require('github-contents');
getContents('lib/xmlrpc-router.js', function (err, contents) {
    console.log(contents);
});

pros

  • uses the official github API and therefore stable (getting files via raw http address is going away).

cons

  • fimited to 60 requests per hour (as per standard github policy for unauthenticated requests).
  • fetches the entire file's contents at once. A streaming method for low memory-consumption would be preferable.

roadmap

At some point I'd like to add a few more methods / options:

  • allow authentication so as to be able to make more requests per hour and/or for getting contents from a private repo
  • add a streaming method for low memory-consumption so that this could be run on a VPS without worrying about memory usage.
  • possibly some other file-related methods, maybe even something like a fs module that works through github transparently

feel free to send PR for the above, other features, etc.

testing

Tests require mocha to be installed.

$ mocha

license

MIT Style License (see LICENSE.txt)