Giter Club home page Giter Club logo

lastweek's Introduction

lastweek

Given a username and/or GitHub access token, this tool will provide a report of the work done by the user last week. This can be useful for sharing with your coworkers, or just for your own notes.

Installing / Quick Start

From released binary

Navigate to tags and find a recent release. Binaries are published for various linux and mac distributions.

export GITHUB_TOKEN=your-token
lastweek

From go install

go install github.com/crwilcox/lastweek@latest

export GITHUB_TOKEN=your-token
lastweek

Note: This assumes ~/go/bin (or wherever go binaries are installed on your system) is on your path. lastweek is likely installed at ~/go/bin/lastweek

Token Scopes

While a GitHub token isn't required, it will restrict the reporting to public activity. It also could result in issues due to GitHub rate limiting. The token created requires the repo scope to access private repositories.

Usage

Token and User can be provided via environment variables. Note, User can be inferred from your GITHUB_TOKEN. Setting a token is recommended as it avoids rate limiting issue as well as gives information about private repository activity.

export GITHUB_USERNAME=your-username
export GITHUB_TOKEN=your-token

They can also be provided by flag, along with other settings.

Usage of lastweek:
  -end_date string
        The end date in ISO layout. E.g. YYYY-MM-DD
  -start_date string
        The start date in ISO layout. E.g. YYYY-MM-DD
  -start_of_week string
        The first day of your snippet week (default "Saturday")
  -token string
        Your GitHub access token.
  -user string
        Your GitHub username.
  -weeks_back int
        The number of weeks ago to see snippets for (default 1)

Acknowledgments

I have written various versions of this tool. This most recent rewrite though was influenced by a version I stumbled on by RJPercival that had went out of date (though had some ideas I liked) as well as another by SethVargo which had a way of formatting the output I preferred to my previous ways. In combining these various elements of each along with elements of previous iterations of my own, I created lastweek.

lastweek's People

Contributors

crwilcox avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

codyoss

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.