<!--
Copyright (c) 2022 Joseph Hale
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
-->
<div align="center">
# Git-Authorship
Interactive reports showing who wrote each line of code in your git repository.
<!-- BADGES -->
[](https://github.com/thehale/git-authorship/blob/master/LICENSE)
[](https://github.com/sponsors/thehale)
[](https://jhale.dev)
[](https://www.linkedin.com/comm/mynetwork/discovery-see-all?usecase=PEOPLE_FOLLOWS&followMember=thehale)
</div>
```bash
pip install git-authorship
git-authorship https://github.com/USERNAME/REPOSITORY
# Open build/authorship.html in a web browser
```
<div align="center">
</div>
## 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](https://github.com/cla-assistant/cla-assistant) and its
corresponding [GitHub
Action](https://github.com/contributor-assistant/github-action) for that
functionality), it does help you clearly identify who your contributors are and
the exact lines of code they wrote.
<!--
To support libraries undergoing re-licensing, `git-authorship` includes config
files for labelling the licenses under which contributors have shared their code.
## Other Features
### Author Licenses
If you want to include information about the OSS license offered by each
contributor, simply add a line for each author to `config/author-licenses.txt`
in the following format:
```
author-name|license-SPDX-id
```
The `author-name` will be matched to the values shown in the generated
authorship report.
_A list of SPDX license identifiers can be found here:
https://spdx.org/licenses/_
### Pseudonyms
If certain files are being attributed to an unexpected author (e.g. if a
contributor copied code from another project, the `blame` would show the
contributor instead of the original author), you can manually override the
`blame` and licensing information using the `config/pseudonyms.txt` file. Use
one line per override in the following format:
```
target-path|actual-author|actual-email|license-SPDX-id
```
All files with a file path containing `target-path` as a substring will be
attributed to the named `actual-author` under the named software license.
_A list of SPDX license identifiers can be found here:
https://spdx.org/licenses/_ -->
## License
Copyright (c) 2022-2024 Joseph Hale, All Rights Reserved
Provided under the terms of the [Mozilla Public License, version 2.0](./LICENSE)
<details>
<summary><b>What does the MPL-2.0 license allow/require?</b></summary>
### 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](https://www.mozilla.org/en-US/MPL/2.0/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.
</details>
Raw data
{
"_id": null,
"home_page": "https://github.com/thehale/git-authorship",
"name": "git-authorship",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "git, blame, authorship, copyright, relicensing, SPDX, SBOM",
"author": "Joseph Hale",
"author_email": "me@jhale.dev",
"download_url": "https://files.pythonhosted.org/packages/9a/e9/07b6266b9dc7bcf5c0578acadad9c389357796edb8a8fc410e010888369e/git_authorship-0.1.3.tar.gz",
"platform": null,
"description": "<!--\n Copyright (c) 2022 Joseph Hale\n \n This Source Code Form is subject to the terms of the Mozilla Public\n License, v. 2.0. If a copy of the MPL was not distributed with this\n file, You can obtain one at http://mozilla.org/MPL/2.0/.\n-->\n\n<div align=\"center\">\n\n# Git-Authorship\n\nInteractive reports showing who wrote each line of code in your git repository.\n\n<!-- BADGES -->\n[](https://github.com/thehale/git-authorship/blob/master/LICENSE)\n[](https://github.com/sponsors/thehale)\n[](https://jhale.dev)\n[](https://www.linkedin.com/comm/mynetwork/discovery-see-all?usecase=PEOPLE_FOLLOWS&followMember=thehale)\n</div>\n\n```bash\npip install git-authorship\n\ngit-authorship https://github.com/USERNAME/REPOSITORY\n\n# Open build/authorship.html in a web browser\n```\n<div align=\"center\">\n\n\n\n</div>\n\n## Why?\n\nCopyright is a thing, and whoever wrote the code in your repository holds an\nexclusive copyright over it unless an agreement has been made otherwise. \n\nWhile `git-authorship` does not help with managing copyright agreements from\ncontributors (see\n[cla-assistant](https://github.com/cla-assistant/cla-assistant) and its\ncorresponding [GitHub\nAction](https://github.com/contributor-assistant/github-action) for that\nfunctionality), it does help you clearly identify who your contributors are and\nthe exact lines of code they wrote.\n\n\n<!-- \nTo support libraries undergoing re-licensing, `git-authorship` includes config\nfiles for labelling the licenses under which contributors have shared their code.\n\n## Other Features\n\n### Author Licenses\nIf you want to include information about the OSS license offered by each\ncontributor, simply add a line for each author to `config/author-licenses.txt`\nin the following format:\n\n```\nauthor-name|license-SPDX-id\n```\n\nThe `author-name` will be matched to the values shown in the generated\nauthorship report.\n\n_A list of SPDX license identifiers can be found here:\nhttps://spdx.org/licenses/_\n\n\n### Pseudonyms\nIf certain files are being attributed to an unexpected author (e.g. if a\ncontributor copied code from another project, the `blame` would show the\ncontributor instead of the original author), you can manually override the\n`blame` and licensing information using the `config/pseudonyms.txt` file. Use\none line per override in the following format:\n\n```\ntarget-path|actual-author|actual-email|license-SPDX-id\n```\n\nAll files with a file path containing `target-path` as a substring will be\nattributed to the named `actual-author` under the named software license.\n\n_A list of SPDX license identifiers can be found here:\nhttps://spdx.org/licenses/_ -->\n\n## License\nCopyright (c) 2022-2024 Joseph Hale, All Rights Reserved\n\nProvided under the terms of the [Mozilla Public License, version 2.0](./LICENSE)\n\n<details>\n\n<summary><b>What does the MPL-2.0 license allow/require?</b></summary>\n\n### TL;DR\n\nYou can use files from this project in both open source and proprietary\napplications, provided you include the above attribution. However, if\nyou modify any code in this project, or copy blocks of it into your own\ncode, you must publicly share the resulting files (note, not your whole\nprogram) under the MPL-2.0. The best way to do this is via a Pull\nRequest back into this project.\n\nIf you have any other questions, you may also find Mozilla's [official\nFAQ](https://www.mozilla.org/en-US/MPL/2.0/FAQ/) for the MPL-2.0 license\ninsightful.\n\nIf you dislike this license, you can contact me about negotiating a paid\ncontract with different terms.\n\n**Disclaimer:** This TL;DR is just a summary. All legal questions\nregarding usage of this project must be handled according to the\nofficial terms specified in the `LICENSE` file.\n\n### Why the MPL-2.0 license?\n\nI believe that an open-source software license should ensure that code\ncan be used everywhere.\n\nStrict copyleft licenses, like the GPL family of licenses, fail to\nfulfill that vision because they only permit code to be used in other\nGPL-licensed projects. Permissive licenses, like the MIT and Apache\nlicenses, allow code to be used everywhere but fail to prevent\nproprietary or GPL-licensed projects from limiting access to any\nimprovements they make.\n\nIn contrast, the MPL-2.0 license allows code to be used in any software\nproject, while ensuring that any improvements remain available for\neveryone.\n\n</details>\n",
"bugtrack_url": null,
"license": "MPL-2.0",
"summary": "Interactive reports showing who wrote each line of code in your git repository.",
"version": "0.1.3",
"project_urls": {
"Documentation": "https://github.com/thehale/git-authorship",
"Homepage": "https://github.com/thehale/git-authorship",
"Repository": "https://github.com/thehale/git-authorship"
},
"split_keywords": [
"git",
" blame",
" authorship",
" copyright",
" relicensing",
" spdx",
" sbom"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f1cd3e8b7b72a44270803c59923a5f73e36c7637690a3d691b7cf6c90ddc3c39",
"md5": "b776d9e1e73950dd3e888f40810fac10",
"sha256": "246bda924ca04f1bbd7f8e9e703ecdfe7d4d9f48ce6c909d7339d83c8effb109"
},
"downloads": -1,
"filename": "git_authorship-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b776d9e1e73950dd3e888f40810fac10",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 14565,
"upload_time": "2024-11-10T06:44:08",
"upload_time_iso_8601": "2024-11-10T06:44:08.529208Z",
"url": "https://files.pythonhosted.org/packages/f1/cd/3e8b7b72a44270803c59923a5f73e36c7637690a3d691b7cf6c90ddc3c39/git_authorship-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9ae907b6266b9dc7bcf5c0578acadad9c389357796edb8a8fc410e010888369e",
"md5": "f16381a60c61d976facec0bcacb68476",
"sha256": "f7c99a111f99c8f5d7d4b0f6136b87f55c7ee997712ecd0a93bb6f853c046db0"
},
"downloads": -1,
"filename": "git_authorship-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "f16381a60c61d976facec0bcacb68476",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 13264,
"upload_time": "2024-11-10T06:44:10",
"upload_time_iso_8601": "2024-11-10T06:44:10.241096Z",
"url": "https://files.pythonhosted.org/packages/9a/e9/07b6266b9dc7bcf5c0578acadad9c389357796edb8a8fc410e010888369e/git_authorship-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-10 06:44:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thehale",
"github_project": "git-authorship",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "git-authorship"
}
JSON
