avgupta456 / github-trends

🚀 Level up your GitHub profile readme with customizable cards including LOC statistics!

GitHub Trends

SPECIAL: GitHub Wrapped

Check out your GitHub Wrapped at githubwrapped.io!

---

What is GitHub Trends

GitHub Trends dives deep into the GitHub API to bring you exciting and impactful metrics about your code contributions. Generate insights on lines written by language, repository, and time. Easily embed dynamic images into your GitHub profile to share your statistics with the world. Check out some of the examples below:

Quickstart

First, visit https://api.githubtrends.io/auth/signup/public and create an account with GitHub Trends. Then, paste this string into your Markdown content, substituting your username.

[![GitHub Trends SVG](https://api.githubtrends.io/user/svg/avgupta456/langs)](https://githubtrends.io)

And voila, you get a card like above. Keep reading to learn more!

Why GitHub Trends?

Unlike other projects which look at just your public repositories, GitHub Trends computes metrics based on your individual commits. If you commit to open-source projects, or have collaborators contribute to your own repositories, GitHub Trends will better measure your own code contributions. Through this method, GitHub Trends is the first project that allows users to surface lines of code written (LOC) by language and repository. Our web interface also allows for easier customization.

Usage

Website Workflow (Alpha)

Visit githubtrends.io to create an account and get started!

Have questions? Check out the demo!

---

API Workflow (Alpha)

Alternatively, you can communicate directly with the API to create and customize your cards. Read docs/API.md to learn more about the API and customizations.

FAQ

See docs/FAQ.md.

Contributing

See docs/CONTRIBUTING.md.

Acknowledgements

Much inspiration was taken from GitHub Readme Stats. If you haven't already, check it out and give it a star!

github-trends's Issues

Disable auto dark mode on frontend

Language by # lines SVG

Create models post analytics

Currently using Dict[str, Any] too much, useful for SVG cards

Implement async caching for _get_user

Needs to handle max_size, ttl expiry, some method of flagging values not to save, handle exceptions

Current method in utils.py does not handle final two points. Ideally write tests to ensure correctness and move to helper.

While subscriber is running, don't repeat task by reloading

Maybe through MongoDB flag

Add CI/CD for frontend

Also checks for code coverage, code quality, etc.

"Most User Languages" breakdown not showing all contributions

My card is apparently not showing the hundreds of C++ LOC I've added this year. I'm guessing this is because that work was done in my organization page. Is there currently a way to calculate those in (or is it planned for the future)?

Interestingly, I can see some of my contributions to my org page on the "Most Contributed Repositories" card, but that is also not counting the aforementioned C++ code. Maybe a factor would be that that particular code is being committed to a secondary branch?

(PY-D0003) Missing module/function docstring

Description

The module/function docstring is missing. If you want to ignore this, you can configure this in the .deepsource.toml file. Please refer to docs for available options.

Occurrences

There are 19 occurrences of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/avgupta456/github-trends/issue/PY-D0003/occurrences/

Explore counting contributions on secondary branches.

Currently we count contributions on the main branch only. See #83 for additional details.

Public vs. Private repo options

Frontend feedback (misc)

remove "progress bar" misconception
make customize link more prominent
change verbige for unreleased features
check font for subheader
don't hide options but grey out

Canny integration

Improve header for mobile view

Use a drop down instead of squishing all the tabs. Standard implementation, can copy other common websites

Investigate backend errors

Using two tokens from MongoDB

Fix PubSub Infinite 500 Error

Start planning themes, create first theme

Create fully website-independent workflow, document in Readme

Create routes for authentication, document existing cards and customizations for each.

Finish end to end pipeline

Low color contrast on date range setting

I'm not sure if this is a UI bug, but the date range setting on the "Customize your SVG" dialog has very low contrast and is hard to read.

Improve query cap warning

How to mark when 1000 commits/contributions reached

Don't query full history each time

Implement function to build upon current record.

Create card/handle incorrect username

Currently throws "Unknown Error" standard exception

Allow users to customize language SVG, hide certain languages

Frontend 404 Page

Better handle SVG for no contributions

Currently if someone has 0 lines added, the language SVG looks very bare. Maybe add an image in the body.

Small bars on the SVGs do not render correctly.

Create Logo

Conditionally disable "Use Private" depending on contrib stats

Maybe create a backend endpoint to return # of private commits over time range using mongodb raw_data

Generally improve website for various viewports

backend feedback (misc)

method to delete account from app
overwrite cache when updating permissions

Move demo GitHub API compute to subscriber

Currently loading stats for the demo users happens on the publisher. This can slow other services like authentication and svgs. We want to move the compute to the subscriber instead.

Update Readme

Set up Google Analytics

Reduce storage size in MongoDB

Main improvement is to replace individual counts with {"count": [0,0,1,0,0,...]}. Create model and functions to handle compression and decompression

Create classes for GitHub API responses

See todo notes in backend/src/external/github_api/*

(PY-D0002) Missing class docstring

Description

Class docstring is missing. If you want to ignore this, you can configure this in the .deepsource.toml file. Please refer to docs for available options.

Occurrences

There are 32 occurrences of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/avgupta456/github-trends/issue/PY-D0002/occurrences/

Add more backend tests

GitHub floating icon on frontend

Top repositories SVG

Demo card

Allow users to see public results without logging in using public access tokens while rate limit lasts

Redirect backend to api.githubtrends.io

Set up Docker for local development

Readme updates

Make it easier to embed in your profile (add a TLDR)
Make distinction from other github repos clearer (commit vs repo, loc)

Add examples to Sign Up page

Add content to landing page

Implement user_refresh

Better handle incomplete query

If any nodes are lost, figure out how to rerun that time range before saving. Especially relevant after #60

Improve timezone handling

Keep track of "Other" repositories as a repository record

Introduced when trimming to show only first 20 repositories for #61

Compact language SVG