Git Product home page Git Product logo

git-profiler's Introduction

git-profiler

By running this project, a user can create a profile README file showing the languages (and frameworks) that he/she contributes most in. This will be displayed in the form of visualizations similar to GitHub's own profile illustrations (eg. timeline heatmap)

Strategy

We want to support various frameworks for easy integration everywhere. We are starting with Python3 and NodeJS.

In each framework, we will create the project in two modules:

  1. core
  2. ui

The core module will be the exportable module which is provided the address of the .git folder for all the repositories that need to be scanned.

The ui module will help any user to use the core module with their cloud git repositories, located in GitHub, GitLab, BitBucket etc.

core

  1. Get commits from .git
  2. For each commit, get all file-changes and map it to the programming language or framework to which it belongs
  3. Store this mapping from "commits to language/framework wise number of file-changes"
  4. Provide functions to visualize and export this information
  5. Provide function to create a README.md file for the user which has contribution language distribution and day-wise heatmap colored by the most used technology in his/her contributions

ui

The overall idea is to clone all the repositories or locate them locally and then utilize the core module to generate the visualizations and README.md.

Github

As an output, we can create a repository by the same name as the user's github-id and add the generated README.md file in that repository.

git-profiler's People

Contributors

avikalpg avatar

Stargazers

Muskan Paliwal avatar  avatar

Watchers

 avatar Muskan Paliwal avatar

git-profiler's Issues

Publish Github profile readme

Check if repository exists with the same names as the user's GitHub id. If not, create the repository and add README.md with visualisation.
Else, ask if user wants to append, replace or discard.!

Rough design for GitHub:
IMG_20200914_120636.jpg

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.