Giter VIP home page Giter VIP logo

git_timelog's Introduction

GitTimelog

A tool to extract daily update from GIT commits.

The tool can return json of the tasks done along with start and end time. As well as simply copy the list of commits done as plain-text list which can be ordered or unordered.

Installation

Execute this line to your root directory

gem install 'git_timelog'

Dependency for Linux

sudo apt-get install xsel

Usage

Executable:

$ git_timelog
  => Copies the commit logs from 6am in the morning
$ git_timelog --since=“6am”
  => Time can be specified since when through this option
$ git_timelog -s “6am”
  => shortcode of —since [6am => :default]
$ git_timelog --format=“json”
  => format = “json” || “ordered” || “unordered”
    “json” => returns the json formatted values
      title:
      description:
      start_time:
      end_time:
    “ordered” => Copies ordered list of daily log in clipboard.
    “unordered” => Copies un-ordered list of daily log in clipboard. [:default]
$ git_timelog -f “json”
  => shortcode of --format
$ git_timelog --help
  => helps you use the executables
$ git_timelog -h
  => shortcode for help
$ git_timelog --emitii
  => Sets emitii to true which updates the API and also asks for:
    access_token:
    emitii_subdomain:
    project_name:
$ git_timelog -e
  => Shortcode for --emitii

Features

  • Get the commits throughout all branch in current repo for current author.
  • The CLI accepts different parameters time to be dynamically chosen.
  • Hours can be specified through commit messages title with format => [2] for two hours.
  • Copy the unordered list to clipboard for easy paste in any time-logger.
  • Copy the ordered list to clipboard for easy paste in any time-logger if preferred.

Future Enhancements

  • Refactor! Refactor!! Refactor!!!
  • YML to be set as hidden within project directory.
  • Only the commits with [1] in title is logged in emitii.

Few Assumptions (to be reduced gradually)

  • need to be in the same repo for update.
  • not to use following in git commits messages or descriptions:
    • git__title:
    • git__description:
    • git__date:

Wanna Contribute? You're Welcome!

  1. Fork it ( https://github.com/sushil10018/git_timelog/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

git_timelog's People

Contributors

sushil10018 avatar gkunwar avatar siwakotisurya avatar

Watchers

 avatar  avatar  avatar

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.