kawarimidoll / deno-github-contributions-api

The unofficial get api of GitHub contributions with Deno 🦕

deno-github-contributions-api

Get your GitHub contributions data powered by Deno!

Usage

as API

In your terminal:

$ curl https://github-contributions-api.deno.dev
# Then follow the messages...

Of course, you can access the endpoint from the web browser: https://github-contributions-api.deno.dev

as deno module

In your deno script file:

import { getContributions } from "https://github.com/kawarimidoll/deno-github-contributions-api/raw/main/mod.ts";

const username = "your-github-username";
const token = "xxxxxxxxxxxxxxxxxxxxxxx";

const contributions = await getContributions(username, token);

console.log(contributions.toTerm({ scheme: "random" }));

You can see an example in main.ts

The personal access token which has a "read:user" scope is required.

Generate your token from this page: https://github.com/settings/tokens/new

Extra

If you are using GitHub CLI, you can call this API from gh-graph.

Acknowledgements

---

if (this.repo.isAwesome || this.repo.isHelpful) {
  star(this.repo);
}

deno-github-contributions-api's Issues

TODO: use latest server style

Now this project is using old server style like deployctl run...
Need to update to latest server stye that use serve in deno_std.

Add `invert` parameter to `term` API

Currently, toTerm() method changes the font color of the terminal.
New feature to change background color instead of font color is wanted.

Please add invert (default: false) parameter to contributions.ts and server.ts.