samg-timetrap 0.0.2 → 0.0.3
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.
- data/LICENSE.txt +23 -0
- data/{README → README.md} +17 -16
- data/lib/timetrap.rb +1 -1
- metadata +3 -2
data/LICENSE.txt
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
http://www.opensource.org/licenses/mit-license.php
|
2
|
+
|
3
|
+
The MIT License
|
4
|
+
|
5
|
+
Copyright (c) 2009 Sam Goldstein
|
6
|
+
|
7
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
8
|
+
of this software and associated documentation files (the "Software"), to deal
|
9
|
+
in the Software without restriction, including without limitation the rights
|
10
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
11
|
+
copies of the Software, and to permit persons to whom the Software is
|
12
|
+
furnished to do so, subject to the following conditions:
|
13
|
+
|
14
|
+
The above copyright notice and this permission notice shall be included in
|
15
|
+
all copies or substantial portions of the Software.
|
16
|
+
|
17
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
18
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
19
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
20
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
21
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
22
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
23
|
+
THE SOFTWARE.
|
data/{README → README.md}
RENAMED
@@ -6,8 +6,9 @@ to be a low-overhead way of tracking what you spend time on. Timetrap
|
|
6
6
|
maintains its state in a sqlite3 database.
|
7
7
|
|
8
8
|
To install:
|
9
|
-
|
10
|
-
|
9
|
+
|
10
|
+
$ gem sources -a http://gems.github.com (you only have to do this once)
|
11
|
+
$ sudo gem install samg-timetrap
|
11
12
|
|
12
13
|
This will place a ``t`` executable in your path.
|
13
14
|
|
@@ -16,7 +17,7 @@ http://bitbucket.org/trevor/timebook/src/
|
|
16
17
|
|
17
18
|
|
18
19
|
Concepts
|
19
|
-
|
20
|
+
--------
|
20
21
|
|
21
22
|
Timetrap maintains a list of *timesheets* -- distinct lists of timed *periods*.
|
22
23
|
Each period has a start and end time, with the exception of the most recent
|
@@ -40,33 +41,33 @@ thus be ambiguous whether a new timesheet ``f`` or switching to the existing
|
|
40
41
|
timesheet ``foo`` was desired).
|
41
42
|
|
42
43
|
Usage
|
43
|
-
|
44
|
+
-----
|
44
45
|
|
45
46
|
The basic usage is as follows::
|
46
47
|
|
47
|
-
|
48
|
-
|
49
|
-
|
48
|
+
$ t switch writing
|
49
|
+
$ t in document timetrap --at "10 minutes ago"
|
50
|
+
$ t out
|
50
51
|
|
51
52
|
The first command, ``t switch writing``, switches to the timesheet "writing"
|
52
53
|
(or creates it if it does not exist). ``t in document timetrap --at "10 minutes
|
53
54
|
ago"`` creates a new period in the current timesheet, and annotates it with the
|
54
55
|
description "document timetrap". The optional --at flag can be passed to start
|
55
56
|
the entry at a time other than the present. Any Chronic or database parsable
|
56
|
-
strings are accepted Note that this command would be in error if the
|
57
|
+
strings are accepted. Note that this command would be in error if the
|
57
58
|
``writing`` timesheet was already active. Finally, ``t out`` records the
|
58
59
|
current time as the end time for the most recent period in the ``writing``
|
59
60
|
timesheet.
|
60
61
|
|
61
62
|
To display the current timesheet, invoke the ``t display`` command::
|
62
63
|
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
64
|
+
$ t display
|
65
|
+
Timesheet writing:
|
66
|
+
Day Start End Duration Notes
|
67
|
+
Mar 14, 2009 19:53:30 - 20:06:15 0:12:45 document timetrap
|
68
|
+
20:07:02 - 0:00:01 write home about timetrap
|
69
|
+
0:12:46
|
70
|
+
Total 0:12:46
|
70
71
|
|
71
72
|
Each period in the timesheet is listed on a row. If the timesheet is active,
|
72
73
|
the final period in the timesheet will have no end time. After each day, the
|
@@ -75,7 +76,7 @@ computed by summing the durations of the periods beginning in the day. In the
|
|
75
76
|
last row, the total time tracked in the timesheet is shown.
|
76
77
|
|
77
78
|
Commands
|
78
|
-
|
79
|
+
--------
|
79
80
|
|
80
81
|
**alter**
|
81
82
|
Inserts a note associated with the currently active period in the timesheet.
|
data/lib/timetrap.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: samg-timetrap
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Sam Goldstein
|
@@ -71,7 +71,8 @@ extensions: []
|
|
71
71
|
extra_rdoc_files: []
|
72
72
|
|
73
73
|
files:
|
74
|
-
- README
|
74
|
+
- README.md
|
75
|
+
- LICENSE.txt
|
75
76
|
- Rakefile
|
76
77
|
- lib/timetrap.rb
|
77
78
|
- bin/t
|