Mercurial > getan
annotate README @ 428:7adc6cd9d23a
TODO: Adds point to move off optparse.
| author | Bernhard Reiter <bernhard@intevation.de> |
|---|---|
| date | Mon, 29 May 2017 14:06:31 +0200 |
| parents | 8b1916aabe65 |
| children | d56fee6fd7ca |
| rev | line source |
|---|---|
|
417
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
1 Usage |
|
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
2 ===== |
|
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
3 |
|
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
4 Call ``getan`` or ``getan.py`` in a terminal to start |
|
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
5 with an empty list of tasks that you want to track time for. |
|
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
6 |
|
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
7 Use the Insert-Key to add a new task to track. |
|
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
8 (A *task* is called *project* within getan.) |
|
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
9 |
|
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
10 Now select one of the projects with the arrow keys from your keyboard |
|
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
11 and press enter to start the clock. See ``INTRODUCTION`` for more keyboard |
|
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
12 commands. |
|
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
13 |
|
418
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
14 The time log entries will be saved in an sqlite database, |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
15 by default getan will create ``~/.getan/time.db``. |
|
417
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
16 The ``scripts/`` will help to generate reports from them. |
|
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
17 |
|
418
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
18 Customization |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
19 ------------- |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
20 |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
21 Use ``~/.getan/getanrc`` or the system-wide ``/etc/getanrc`` |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
22 to customize keys and colors. See ``getan/config.py`` for |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
23 the recognized options. Example:: |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
24 |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
25 [keybindings] |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
26 # changes the insert function to be activated by the `)` key |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
27 insert: ) |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
28 |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
29 [theme] |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
30 header: light green, dark green |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
31 body: light green, black |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
32 |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
33 |
|
cd990c7dc746
Version: Prepares for 2.0.post1 release.
Bernhard Reiter <bernhard@intevation.de>
parents:
417
diff
changeset
|
34 |
| 288 | 35 Installation |
| 36 ============ | |
| 0 | 37 |
|
336
a3d1fc6c0153
README updated: New urwid.org homepage and location simplified. Typo fixed.
Bernhard Reiter <bernhard@intevation.de>
parents:
291
diff
changeset
|
38 Getan requires `urwid <http://urwid.org/>`_ in a version >= 1.0. Urwid is |
|
367
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
39 a console user interface library written in Python. For console output e.g. |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
40 zeiterfassung.py Getan also requires `Jinja2 <http://jinja.pocoo.org/>_`. |
| 261 | 41 |
| 288 | 42 Install urwid |
| 43 ------------- | |
|
23
9c4e8ba3c4fa
Added a new implementation of 'getan' based on urwid, a python console user interface library.
Ingo Weinzierl <ingo_weinzierl@web.de>
parents:
3
diff
changeset
|
44 |
| 288 | 45 On Debian GNU/Linux >= Wheezy just run as root::: |
| 46 | |
| 47 $ apt-get install python-urwid | |
| 48 | |
| 49 On other systems urwid may be installed via pip or directly put into the sources | |
| 50 of getan. | |
| 51 | |
| 52 Using pip | |
| 53 ^^^^^^^^^ | |
| 54 | |
| 55 To install urwid via pip run as root:: | |
| 56 | |
| 57 $ pip install urwid | |
| 58 | |
| 59 Or if you prefer using a virtualenv:: | |
| 60 | |
|
414
69ef6f89e930
Prepares release v2.0.
Bernhard Reiter <bernhard@intevation.de>
parents:
367
diff
changeset
|
61 $ virtualenv getan-env |
| 288 | 62 $ source getan-env/bin/activate |
|
414
69ef6f89e930
Prepares release v2.0.
Bernhard Reiter <bernhard@intevation.de>
parents:
367
diff
changeset
|
63 (getan-env)$ pip install -U pip # to get the latest pip |
| 288 | 64 (getan-env)$ pip install urwid |
| 65 | |
| 66 Using urwid sources | |
| 67 ^^^^^^^^^^^^^^^^^^^ | |
| 68 | |
| 69 Urwid can be put as source to the getan directory when getan is run directly | |
| 70 from the sources. Urwid source can be downloaded from `pypi | |
|
336
a3d1fc6c0153
README updated: New urwid.org homepage and location simplified. Typo fixed.
Bernhard Reiter <bernhard@intevation.de>
parents:
291
diff
changeset
|
71 <https://pypi.python.org/pypi/urwid/>`_. |
| 288 | 72 |
|
337
96a8545eb247
README: updated for urwid 1.1.2. Better example shell commands for using urwid from source.
Bernhard Reiter <bernhard@intevation.de>
parents:
336
diff
changeset
|
73 For urwid 1.1.2 the direct download link from pypi is |
|
340
325499a01b65
Use text width of 80 chars per line in README
Björn Ricks <bjoern.ricks@intevation.de>
parents:
337
diff
changeset
|
74 `<https://pypi.python.org/packages/source/u/urwid/urwid-1.1.2.tar.gz>`_ |
|
325499a01b65
Use text width of 80 chars per line in README
Björn Ricks <bjoern.ricks@intevation.de>
parents:
337
diff
changeset
|
75 (sha256sum is |
|
325499a01b65
Use text width of 80 chars per line in README
Björn Ricks <bjoern.ricks@intevation.de>
parents:
337
diff
changeset
|
76 f56568b4f8459b3265c65d9e275ef72df6cb16ad0c291f0feb027cc911ea0f26).:: |
| 288 | 77 |
| 78 $ cd getan-source | |
|
337
96a8545eb247
README: updated for urwid 1.1.2. Better example shell commands for using urwid from source.
Bernhard Reiter <bernhard@intevation.de>
parents:
336
diff
changeset
|
79 $ v=urwid-1.1.2 |
|
96a8545eb247
README: updated for urwid 1.1.2. Better example shell commands for using urwid from source.
Bernhard Reiter <bernhard@intevation.de>
parents:
336
diff
changeset
|
80 $ curl -O https://pypi.python.org/packages/source/u/urwid/$v.tar.gz |
|
96a8545eb247
README: updated for urwid 1.1.2. Better example shell commands for using urwid from source.
Bernhard Reiter <bernhard@intevation.de>
parents:
336
diff
changeset
|
81 $ sha256sum $v.tar.gz |
|
96a8545eb247
README: updated for urwid 1.1.2. Better example shell commands for using urwid from source.
Bernhard Reiter <bernhard@intevation.de>
parents:
336
diff
changeset
|
82 $ tar -xzvf $v.tar.gz |
|
96a8545eb247
README: updated for urwid 1.1.2. Better example shell commands for using urwid from source.
Bernhard Reiter <bernhard@intevation.de>
parents:
336
diff
changeset
|
83 $ ln -s $v/urwid urwid |
| 288 | 84 |
|
367
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
85 Install Jinja2 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
86 -------------- |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
87 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
88 On Debian GNU/Linux just run as root::: |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
89 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
90 $ apt-get install python-jinja2 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
91 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
92 On other systems jinja2 may be installed via pip or directly put into the |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
93 sources of getan. |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
94 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
95 Using pip |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
96 ^^^^^^^^^ |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
97 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
98 To install jinja2 via pip run as root:: |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
99 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
100 $ pip install jinja2 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
101 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
102 Or if you prefer using a virtualenv:: |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
103 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
104 $ source getan-env/bin/activate |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
105 (getan-env)$ pip install jinja2 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
106 |
| 288 | 107 Install getan |
| 108 ------------- | |
| 109 | |
| 110 A installation of getan is not required. It can also be run directly from the | |
| 111 sources. To install getan system wide the following command must be run as root | |
| 112 user:: | |
| 113 | |
| 114 $ python setup.py install | |
| 115 | |
| 116 Starting getan | |
| 117 ============== | |
| 118 | |
| 119 Getan can be directly run from sources or after a system wide installation from | |
| 120 the bin dir (e.g. /usr/bin). | |
| 121 | |
| 122 Running from Sources | |
| 123 -------------------- | |
| 124 | |
| 125 To run getan from the sources run:: | |
| 0 | 126 |
|
23
9c4e8ba3c4fa
Added a new implementation of 'getan' based on urwid, a python console user interface library.
Ingo Weinzierl <ingo_weinzierl@web.de>
parents:
3
diff
changeset
|
127 $ ./getan.py |
| 0 | 128 |
| 288 | 129 or:: |
| 0 | 130 |
| 288 | 131 $ ./getan.py /path/to/mytime.db |
| 0 | 132 |
|
341
148300d6f126
Fix typos in README
Björn Ricks <bjoern.ricks@intevation.de>
parents:
340
diff
changeset
|
133 to choose a different sqlite3 database then the default time.db |
| 288 | 134 |
| 135 The classic version of 'getan' which is based on curses can be run with:: | |
| 136 | |
|
23
9c4e8ba3c4fa
Added a new implementation of 'getan' based on urwid, a python console user interface library.
Ingo Weinzierl <ingo_weinzierl@web.de>
parents:
3
diff
changeset
|
137 $ classic/getan |
|
9c4e8ba3c4fa
Added a new implementation of 'getan' based on urwid, a python console user interface library.
Ingo Weinzierl <ingo_weinzierl@web.de>
parents:
3
diff
changeset
|
138 |
| 288 | 139 or:: |
|
23
9c4e8ba3c4fa
Added a new implementation of 'getan' based on urwid, a python console user interface library.
Ingo Weinzierl <ingo_weinzierl@web.de>
parents:
3
diff
changeset
|
140 |
| 288 | 141 $ classic/getan /path/to/mytime.db |
| 142 | |
| 143 Running from installation | |
| 144 ------------------------- | |
| 145 | |
| 146 After installing getan it can be run with:: | |
| 147 | |
| 148 $ getan | |
| 149 | |
| 150 or:: | |
| 151 | |
| 152 $ getan /path/to/mytime.db | |
| 153 | |
| 154 The classic version of 'getan' is also available:: | |
| 155 | |
| 156 $ getan-classic | |
| 157 | |
| 158 or:: | |
| 159 | |
| 160 $ getan-classic /path/to/mytime.db | |
|
342
0ad38a86b1e6
Add vim modeline to REAMDE file
Björn Ricks <bjoern.ricks@intevation.de>
parents:
341
diff
changeset
|
161 |
|
424
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
162 |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
163 CREDITS |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
164 ======= |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
165 Getan is Free Software licensed under the terms of GPLv3 or later. |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
166 For details see LICENSE coming with the source of 'getan'. |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
167 |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
168 |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
169 Main development |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
170 ---------------- |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
171 2014-(current maintainer) Bernhard E. Reiter <bernhard@intevation.de> |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
172 2011-2014 Björn Ricks <bjoern.ricks@intevation.de> |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
173 2010 Ingo Weinzierl <ingo.weinzierl@intevation.de> |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
174 2009-2014 Thomas Arendsen Hein <thomas@intevation.de> |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
175 2008-2010 Sascha L. Teichmann <sascha.teichmann@intevation.de> |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
176 |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
177 Contributions |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
178 ------------- |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
179 Stephan Holl |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
180 Tom Gottfried |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
181 |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
182 Thanks |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
183 ------ |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
184 To all users that gave feedback, especially at Intevation. |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
185 |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
186 |
|
8b1916aabe65
Docs: adds CREDITS section with license info.
Bernhard Reiter <bernhard@intevation.de>
parents:
418
diff
changeset
|
187 |
|
417
d6d9d319bd2e
Prepares for PyPi publication.
Bernhard Reiter <bernhard@intevation.de>
parents:
414
diff
changeset
|
188 .. vim: set ts=4 sw=4 tw=80 filetype=rst : |