gitmarshal 1.1.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +51 -11
- data/gitmarshal.gemspec +12 -13
- data/lib/gitmarshal/cli.rb +4 -4
- data/lib/gitmarshal/version.rb +1 -1
- data/lib/gitmarshal.rb +2 -2
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d90917df2e1981597d8b13ed42de81a096e70afdb82c9861659d14d1bfa7fe06
|
4
|
+
data.tar.gz: 90a6709426c96fc7799d14ff700540e295206463cd7e2ee29f06088f55b01185
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7e90700eac894369e3bfe07fef83cbb2515e58d8db30b37667b3aadcd8e15ff180750b4b99081ac6c71ecf6ec74e66f7af2880a4503a31e9b52c93d11f93f18f
|
7
|
+
data.tar.gz: 2c09785145ab76e52124c0ab1edd67313159ed1371c6d3bb60608ad4194dfd98022186c5c2da8fdc7c219a814f4bd266389363ab47ecebdabd1ff788ce11f77f
|
data/README.md
CHANGED
@@ -1,9 +1,28 @@
|
|
1
|
-
|
2
|
-
|
1
|
+
<h1 align="center">
|
2
|
+
GitMarshal
|
3
|
+
</h1>
|
4
|
+
|
5
|
+
<p align="center">
|
6
|
+
<img src="https://github.com/nagstler/gitmarshal/assets/1298480/b488174b-7a33-4932-ada8-1b34f641b2a5.gif" alt="animated" />
|
7
|
+
</p>
|
3
8
|
|
4
|
-
GitMarshal is a command-line interface (CLI) to extract and display various statistics about GitHub repositories. The metrics it retrieves include the number of commits, pull requests, issues, stars, and contributors.
|
5
9
|
|
10
|
+
<p align="center">
|
11
|
+
GitMarshal is a command-line interface (CLI) to extract and display various statistics about GitHub repositories. The metrics it retrieves include the number of commits, pull requests, issues, stars, and contributors.
|
6
12
|
Whether you're a developer interested in the activity of a repository or a manager tracking the progress of your project, GitMarshal provides an easy way to fetch this data directly from your command line.
|
13
|
+
</p>
|
14
|
+
|
15
|
+
|
16
|
+
<p align="center">
|
17
|
+
<a href="https://badge.fury.io/rb/gitmarshal"><img src="https://badge.fury.io/rb/gitmarshal.svg" alt="Gem Version"></a>
|
18
|
+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"></a>
|
19
|
+
<a href="https://codeclimate.com/github/nagstler/gitmarshal/maintainability"><img src="https://api.codeclimate.com/v1/badges/a9c81f4f449374df1e0c/maintainability" alt="Maintainability"></a>
|
20
|
+
<a href="https://github.com/nagstler/gitmarshal/actions/workflows/gem-push.yml"><img src="https://github.com/nagstler/gitmarshal/actions/workflows/gem-push.yml/badge.svg?branch=main" alt="CI Build"></a>
|
21
|
+
</p>
|
22
|
+
|
23
|
+
|
24
|
+
|
25
|
+
|
7
26
|
|
8
27
|
## :sparkles: Features
|
9
28
|
|
@@ -28,22 +47,42 @@ Whether you're a developer interested in the activity of a repository or a manag
|
|
28
47
|
- [License](#license)
|
29
48
|
|
30
49
|
## Prerequisites
|
50
|
+
### 1. Verify Ruby Installation
|
31
51
|
|
32
|
-
Before installing GitMarshal,
|
52
|
+
Before installing GitMarshal, ensure Ruby (version 2.5 or later) is installed on your system. Check your Ruby version using:
|
33
53
|
|
34
54
|
```bash
|
35
55
|
ruby -v
|
36
56
|
```
|
37
57
|
|
38
|
-
|
58
|
+
### 2. Install Ruby (If Not Installed)
|
59
|
+
|
60
|
+
If Ruby is not installed or the version is below 2.5, follow the instructions below to install or upgrade Ruby:
|
61
|
+
#### Ubuntu
|
62
|
+
|
63
|
+
```bash
|
64
|
+
sudo apt-get update
|
65
|
+
sudo apt-get install ruby-full
|
66
|
+
```
|
67
|
+
|
68
|
+
#### MacOS
|
69
|
+
|
70
|
+
```bash
|
71
|
+
brew install ruby
|
72
|
+
```
|
73
|
+
|
74
|
+
#### Windows
|
39
75
|
|
40
|
-
|
41
|
-
|
42
|
-
2. Enter a Note (this can be anything, e.g., "For GitMarshal").
|
43
|
-
3. Under "Select scopes", check the "repo" option.
|
44
|
-
4. Click on "Generate token" at the bottom.
|
76
|
+
Follow the instructions on the [Ruby Installer download page](https://rubyinstaller.org/downloads/) .
|
77
|
+
### 3. Generate GitHub Access Token
|
45
78
|
|
46
|
-
|
79
|
+
To use GitMarshal, generate a GitHub access token:
|
80
|
+
1. Visit [GitHub Tokens New](https://github.com/settings/tokens/new)
|
81
|
+
2. Enter a Note (e.g., "For GitMarshal").
|
82
|
+
3. Check the "repo" option under "Select scopes".
|
83
|
+
4. Click "Generate token" and save the generated token for configuration.
|
84
|
+
|
85
|
+
Now, with Ruby installed and a GitHub token generated, you are ready to install and configure GitMarshal.
|
47
86
|
|
48
87
|
## Installation
|
49
88
|
|
@@ -52,6 +91,7 @@ GitMarshal can be installed directly as a Ruby gem. To do so, simply run the fol
|
|
52
91
|
```bash
|
53
92
|
gem install gitmarshal
|
54
93
|
```
|
94
|
+
|
55
95
|
This command will download and install the GitMarshal gem onto your system.
|
56
96
|
|
57
97
|
## Configuration
|
data/gitmarshal.gemspec
CHANGED
@@ -3,19 +3,19 @@
|
|
3
3
|
require_relative "lib/gitmarshal/version"
|
4
4
|
|
5
5
|
Gem::Specification.new do |spec|
|
6
|
-
spec.name
|
7
|
-
spec.version
|
8
|
-
spec.authors
|
9
|
-
spec.email
|
6
|
+
spec.name = "gitmarshal"
|
7
|
+
spec.version = Gitmarshal::VERSION
|
8
|
+
spec.authors = ["Nagendra Dhanakeerthi"]
|
9
|
+
spec.email = ["nagendra.dhanakeerthi@gmail.com"]
|
10
10
|
|
11
|
-
spec.summary
|
12
|
-
spec.description
|
11
|
+
spec.summary = "Command-line tool for fetching and displaying GitHub repository metrics"
|
12
|
+
spec.description = <<-DESC
|
13
13
|
GitMarshal is a command-line tool that allows developers to fetch and display various metrics
|
14
14
|
about GitHub repositories. It provides insights into issues, stargazers, forks, commits,
|
15
15
|
pull requests, and more.
|
16
16
|
DESC
|
17
|
-
spec.homepage
|
18
|
-
spec.license
|
17
|
+
spec.homepage = "https://github.com/nagstler/gitmarshal"
|
18
|
+
spec.license = "MIT"
|
19
19
|
spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
|
20
20
|
|
21
21
|
spec.metadata["allowed_push_host"] = "https://rubygems.org"
|
@@ -31,14 +31,14 @@ Gem::Specification.new do |spec|
|
|
31
31
|
spec.add_dependency "json", "~> 2.5"
|
32
32
|
spec.add_dependency "thor", "~> 1.1"
|
33
33
|
spec.add_dependency "terminal-table", "~> 3.0.0"
|
34
|
-
spec.add_dependency
|
35
|
-
spec.add_dependency
|
36
|
-
spec.add_dependency
|
34
|
+
spec.add_dependency "colorize", "~> 0.8"
|
35
|
+
spec.add_dependency "octokit", "~> 4.0"
|
36
|
+
spec.add_dependency "faraday-retry", "~> 2.0"
|
37
37
|
|
38
38
|
# Development Dependencies
|
39
39
|
spec.add_development_dependency "rspec", "~> 3.10"
|
40
40
|
spec.add_development_dependency "rubocop", "~> 1.22"
|
41
|
-
|
41
|
+
|
42
42
|
spec.post_install_message = <<-MSG
|
43
43
|
|
44
44
|
#################################################################
|
@@ -58,5 +58,4 @@ Enjoy using GitMarshal!
|
|
58
58
|
#################################################################
|
59
59
|
|
60
60
|
MSG
|
61
|
-
|
62
61
|
end
|
data/lib/gitmarshal/cli.rb
CHANGED
@@ -27,7 +27,7 @@ module GitMarshal
|
|
27
27
|
]
|
28
28
|
end
|
29
29
|
|
30
|
-
table = Terminal::Table.new :title => "Repositories".colorize(:
|
30
|
+
table = Terminal::Table.new :title => "Repositories".colorize(:blue).bold,
|
31
31
|
:headings => ["Name", "Issues", "Stargazers", "Forks"].map { |i| i.colorize(:magenta).bold },
|
32
32
|
:rows => rows
|
33
33
|
|
@@ -43,10 +43,10 @@ module GitMarshal
|
|
43
43
|
rows << ["gitmarshal", "List all repositories of the authenticated user"]
|
44
44
|
rows << ["gitmarshal repo-name", "Show the overall metrics of the given repository"]
|
45
45
|
rows << ["gitmarshal repo-name --today", "Show today's metrics of the given repository"]
|
46
|
-
|
46
|
+
|
47
47
|
table = Terminal::Table.new :rows => rows
|
48
|
-
table.title = "GitMarshal Commands".colorize(:
|
49
|
-
table.headings = [
|
48
|
+
table.title = "GitMarshal Commands".colorize(:blue).bold
|
49
|
+
table.headings = ["Command", "Description"].map { |i| i.colorize(:magenta).bold }
|
50
50
|
table.style = { :border_x => "=", :border_i => "x", :alignment => :left }
|
51
51
|
puts table
|
52
52
|
end
|
data/lib/gitmarshal/version.rb
CHANGED
data/lib/gitmarshal.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: gitmarshal
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.2.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Nagendra Dhanakeerthi
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-07-
|
11
|
+
date: 2023-07-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: json
|