git_timelog 0.0.2 → 0.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +62 -11
- data/lib/git_timelog/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: af86eb96ac30faa0edfd342dc6f0434bab611d24
|
|
4
|
+
data.tar.gz: 4668c9ff022be4188988e774e7c4c22b3b513dce
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 80f675d4d2a74c8a80abfc455324000d5931ce57006c32ee06f6c7f57c244ae5f18f02dc4a05a1df688392c3c643451a65a91a0cfe124c4cfb051e0f927f7cf4
|
|
7
|
+
data.tar.gz: 09b451cd330adffc6d98f5ca4cfa8e0b478272ca5a5fc15493ccd9eda4259d3a8d621629908f1dbe8b3c7e091b130f9d99fea1b595ca98f5df0a3d138fbbe8c5
|
data/README.md
CHANGED
|
@@ -1,30 +1,81 @@
|
|
|
1
1
|
# GitTimelog
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A tool to extract daily update from GIT commits.
|
|
4
|
+
|
|
5
|
+
The tool can return json of the tasks done along with start and end time. As well as simply copy the list of commits done as plain-text list which can be ordered or unordered.
|
|
4
6
|
|
|
5
7
|
## Installation
|
|
6
8
|
|
|
7
|
-
|
|
9
|
+
Execute this line to your root directory
|
|
8
10
|
|
|
9
11
|
```ruby
|
|
10
|
-
gem 'git_timelog'
|
|
12
|
+
gem install 'git_timelog'
|
|
11
13
|
```
|
|
12
14
|
|
|
13
|
-
|
|
15
|
+
## Dependency for Linux
|
|
14
16
|
|
|
15
|
-
|
|
17
|
+
sudo apt-get install xsel
|
|
16
18
|
|
|
17
|
-
|
|
19
|
+
## Usage
|
|
18
20
|
|
|
19
|
-
|
|
21
|
+
Executable:
|
|
20
22
|
|
|
21
|
-
|
|
23
|
+
$ git_timelog
|
|
24
|
+
=> Copies the commit logs from 6am in the morning
|
|
25
|
+
$ git_timelog --since=“6am”
|
|
26
|
+
=> Time can be specified since when through this option
|
|
27
|
+
$ git_timelog -s “6am”
|
|
28
|
+
=> shortcode of —since [6am => :default]
|
|
29
|
+
$ git_timelog --format=“json”
|
|
30
|
+
=> format = “json” || “ordered” || “unordered”
|
|
31
|
+
“json” => returns the json formatted values
|
|
32
|
+
title:
|
|
33
|
+
description:
|
|
34
|
+
start_time:
|
|
35
|
+
end_time:
|
|
36
|
+
“ordered” => Copies ordered list of daily log in clipboard.
|
|
37
|
+
“unordered” => Copies un-ordered list of daily log in clipboard. [:default]
|
|
38
|
+
$ git_timelog -f “json”
|
|
39
|
+
=> shortcode of --format
|
|
40
|
+
$ git_timelog --help
|
|
41
|
+
=> helps you use the executables
|
|
42
|
+
$ git_timelog -h
|
|
43
|
+
=> shortcode for help
|
|
44
|
+
$ git_timelog --emitii
|
|
45
|
+
=> Sets emitii to true which updates the API and also asks for:
|
|
46
|
+
access_token:
|
|
47
|
+
emitii_subdomain:
|
|
48
|
+
project_name:
|
|
49
|
+
$ git_timelog -e
|
|
50
|
+
=> Shortcode for --emitii
|
|
51
|
+
|
|
52
|
+
## Features
|
|
53
|
+
|
|
54
|
+
- Get the commits throughout all branch in current repo for current author.
|
|
55
|
+
- The CLI accepts different parameters
|
|
56
|
+
time to be dynamically chosen.
|
|
57
|
+
- Hours can be specified through commit messages title with format => [2] for two hours.
|
|
58
|
+
- Copy the unordered list to clipboard for easy paste in any time-logger.
|
|
59
|
+
- Copy the ordered list to clipboard for easy paste in any time-logger if preferred.
|
|
60
|
+
|
|
61
|
+
## Future Enhancements
|
|
62
|
+
|
|
63
|
+
- Refactor! Refactor!! Refactor!!!
|
|
64
|
+
- YML to be set as hidden within project directory.
|
|
65
|
+
- Only the commits with [1] in title is logged in emitii.
|
|
66
|
+
|
|
67
|
+
## Few Assumptions (to be reduced gradually)
|
|
68
|
+
|
|
69
|
+
- need to be in the same repo for update.
|
|
70
|
+
- not to use following in git commits messages or descriptions:
|
|
71
|
+
- git__title:
|
|
72
|
+
- git__description:
|
|
73
|
+
- git__date:
|
|
22
74
|
|
|
23
|
-
TODO: Write usage instructions here
|
|
24
75
|
|
|
25
|
-
##
|
|
76
|
+
## Wanna Contribute? You're Welcome!
|
|
26
77
|
|
|
27
|
-
1. Fork it ( https://github.com/
|
|
78
|
+
1. Fork it ( https://github.com/sushil10018/git_timelog/fork )
|
|
28
79
|
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
29
80
|
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
30
81
|
4. Push to the branch (`git push origin my-new-feature`)
|
data/lib/git_timelog/version.rb
CHANGED