Skip to main content

A small cli to like and receive likes four your code in a git controlled code base.

Project description

git-like

Give your coworkers the appreciation they deserve without enduring the complex dynamics of social interaction.

When browsing the code base of coworkers or open-source projects I often find myself appreciating the work of my fellow coders. Be it because they found a smart solution for a problem or just because they kept to a certain style guide we committed on. However, communication can be a tedious task which distracts the sender as well as the receiver, so the appreciation usually does not cross the borders of my brain.

Git-like is a small CLI which aims to make everyday life of us programmers a bit more collaborative, fun and finally - rewarding.

The concept is quite simple. Whenever you find a nice piece of code, you like it by typing something like

$ git-like like FILE FROM_LINE TO_LINE

and the author contributing most to the block of code you select receives a like in shape of a notification. In between all the frustrations which come with coding, this will give him a small positive incentive to continue his good work. A digitial clap on the shoulder.

By using information from your git configuration, git-likes setup is minimal.

Setup

You are 4 steps apart from liking and receiving likes:

1) Installation

$ pip install git-like

2) Claiming your email address

To prevent other people from using your email, you need to claim it. Therefore, we will email you an access code.

$ git-like claim YOUR-EMAIL
$ git-like claim YOUR-EMAIL --code ACCESS_CODE

3) Starting the daemon

git-like comes with a lightweight background process checking for new likes. You can start and stop it by using the cli.

$ git-like start
$ git-like stop

Git-like uses the email in your commits and in your ~/.gitconfig file to identify you. Be sure to configure your config correctly to receive likes.

Commands

  • git-like claim YOUR-EMAIL - Request an access token for your email
    • YOUR_EMAIL - The email address you have configured in your .gitconfig.
  • git-like claim YOUR-EMAIL --code CODE - Enter your access token to claim your email address
    • YOUR_EMAIL - The email address you have configured in your .gitconfig.
    • CODE - The code we sent you in an email
  • git-like like FILE LINE_TO LINE_FROM - Like a set of lines in a given file
    • FILE - The (local) file containing the code snippet you want to like. The file must be part of a git project
    • LINE_FROM - A number indicating the start of the code snippet you want to like
    • LINE_TO - A number indicating the end of the code snippet you want to like
  • git-like start - Start the git-like daemon to be able to receive likes
  • git-like stop - Stop the git-like daemon to stop receiving likes

Privacy

We only collect metadata. So your code is safe. Git-like collects following information when you like a piece of code:

  • your email
  • authors email
  • line number
  • git project url

Integrations

A Jetbrains Intellij plugin is WIP.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

git-like-0.0.6.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

git_like-0.0.6-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file git-like-0.0.6.tar.gz.

File metadata

  • Download URL: git-like-0.0.6.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for git-like-0.0.6.tar.gz
Algorithm Hash digest
SHA256 a17720f8a992527228407df13f192614c864889a71d60316c23b2d307e30a350
MD5 a39b1d21dd8faab702298d79293accbd
BLAKE2b-256 f86a7bcb5846fed72b6b692d162d3c758ee34d2ab2023c7b6db85a4098253305

See more details on using hashes here.

File details

Details for the file git_like-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: git_like-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for git_like-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 88dda5deed5791ce21998320144022152658a961fe659df7c900fb900306d527
MD5 047839f2b4ed98de8d2580ad938a4627
BLAKE2b-256 f0ce72556d48422dfe098381ed906c47edce10549eb7d751fc84f0fe483c0271

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page