Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gruns/gitauthors
✍️ Get a quick summary of a repo's authors.
https://github.com/gruns/gitauthors
authors command-line command-line-tool contributors github python python3 repository repository-tools tool
Last synced: 21 days ago
JSON representation
✍️ Get a quick summary of a repo's authors.
- Host: GitHub
- URL: https://github.com/gruns/gitauthors
- Owner: gruns
- License: mit
- Created: 2018-07-18T05:54:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-20T20:23:26.000Z (almost 4 years ago)
- Last Synced: 2024-11-27T18:49:02.324Z (about 1 month ago)
- Topics: authors, command-line, command-line-tool, contributors, github, python, python3, repository, repository-tools, tool
- Language: Python
- Homepage:
- Size: 47.9 KB
- Stars: 61
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# GitAuthors
GitAuthors is simple tool that prints a quick summary of a repository's authors,
as collated by commits. Summary output includes each author's name, email,
number of commits, and date of last commit.
Once installed, GitAuthors is available via the `gitauthors` command.
### Usage
To use, provide `gitauthors` the URL of a respository and let it go to
work. `gitauthors` will, in turn:
1. Check out the repository into a temporary directory.
2. Parse the repository's log history.
3. Collate a list of the repository's authors and their commits.
4. Output a nicely formatted summary of the repository's authors and their
commits.
5. Clean up after itself and delete the temporary directory.
Example:
```
$ gitauthors https://github.com/gruns/gitauthors
Ansgar Grunseid [email protected] 16 commits, latest on Aug 06, 2018
Ansgar Grunseid [email protected] 1 commit, latest on Jul 17, 2018
```
That's it. Simple.
Of course `gitauthors` can also be imported and used programmatically, too.
```python
>>> from gitauthors import collateGitAuthors, formatGitAuthors
>>>
>>> authors = collateGitAuthors('https://github.com/gruns/gitauthors')
>>> authors[0]
('[email protected]', 'grun', 46, time.struct_time(tm_year=2018, tm_mon=7, tm_mday=18, tm_hour=7, tm_min=8, tm_sec=14, tm_wday=2, tm_yday=199, tm_isdst=0))
>>>
>>> formatted = formatGitAuthors(authors)
>>> print(formatted)
grun [email protected] 46 commits, latest on Jul 18, 2018
Ansgar Grunseid [email protected] 1 commit, latest on Jul 18, 2018
```
### Installation
Installing GitAuthors with pip is easy.
```
$ pip install gitauthors
```