Skip to main content

Interactive reports showing who wrote each line of code in your git repository.

Project description

Git-Authorship

Interactive reports showing who wrote each line of code in your git repository.

Joseph Hale's software engineering blog

pip install git-authorship

git-authorship https://github.com/USERNAME/REPOSITORY

# Open build/authorship.html in a web browser

GIF demonstrating an interactive report of the authors of the cubing library cubing.js

Why?

Copyright is a thing, and whoever wrote the code in your repository holds an exclusive copyright over it unless an agreement has been made otherwise.

While git-authorship does not help with managing copyright agreements from contributors (see cla-assistant and its corresponding GitHub Action for that functionality), it does help you clearly identify who your contributors are and the exact lines of code they wrote.

License

Copyright (c) 2022-2024 Joseph Hale, All Rights Reserved

Provided under the terms of the Mozilla Public License, version 2.0

What does the MPL-2.0 license allow/require?

TL;DR

You can use files from this project in both open source and proprietary applications, provided you include the above attribution. However, if you modify any code in this project, or copy blocks of it into your own code, you must publicly share the resulting files (note, not your whole program) under the MPL-2.0. The best way to do this is via a Pull Request back into this project.

If you have any other questions, you may also find Mozilla's official FAQ for the MPL-2.0 license insightful.

If you dislike this license, you can contact me about negotiating a paid contract with different terms.

Disclaimer: This TL;DR is just a summary. All legal questions regarding usage of this project must be handled according to the official terms specified in the LICENSE file.

Why the MPL-2.0 license?

I believe that an open-source software license should ensure that code can be used everywhere.

Strict copyleft licenses, like the GPL family of licenses, fail to fulfill that vision because they only permit code to be used in other GPL-licensed projects. Permissive licenses, like the MIT and Apache licenses, allow code to be used everywhere but fail to prevent proprietary or GPL-licensed projects from limiting access to any improvements they make.

In contrast, the MPL-2.0 license allows code to be used in any software project, while ensuring that any improvements remain available for everyone.

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_authorship-0.1.5.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

git_authorship-0.1.5-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file git_authorship-0.1.5.tar.gz.

File metadata

  • Download URL: git_authorship-0.1.5.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.8.18 Linux/5.15.153.1-microsoft-standard-WSL2

File hashes

Hashes for git_authorship-0.1.5.tar.gz
Algorithm Hash digest
SHA256 fac8d40791d659fd91fee9713cd8868e7e3e3cd892b8f0e8fe4d90c578a2e28f
MD5 69cbf1510a23b7e12a6222e343c623dd
BLAKE2b-256 9e3262ed7dca2705f00f4822cd8f45783afc9d3d768b07d4c66ed32437f94f91

See more details on using hashes here.

File details

Details for the file git_authorship-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: git_authorship-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.8.18 Linux/5.15.153.1-microsoft-standard-WSL2

File hashes

Hashes for git_authorship-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 dbc4a29c5e12b3d40313daa394dd163912a4931edc5870a49dafa0a1f7303696
MD5 09089a51ebfdcd13b28e5e75886a57ba
BLAKE2b-256 778fccfccffad40cad0fdb0739b6a38ee57c158710580b1ed4731d5c5092bc51

See more details on using hashes here.

Supported by

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