annotate README @ 416:857d76de4a2f

Version: bumped to 2.0.dev0 * Switches to a development release version conforming to PEP 440.
author Bernhard Reiter <bernhard@intevation.de>
date Wed, 03 May 2017 14:06:35 +0200
parents 69ef6f89e930
children d6d9d319bd2e
rev   line source
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
1 Installation
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
2 ============
0
7eb7886ed8fd Initial import.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
diff changeset
3
336
a3d1fc6c0153 README updated: New urwid.org homepage and location simplified. Typo fixed.
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
4 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
5 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
6 zeiterfassung.py Getan also requires `Jinja2 <http://jinja.pocoo.org/>_`.
261
cf905ed23de0 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 259
diff changeset
7
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
8 Install urwid
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
9 -------------
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
10
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
11 On Debian GNU/Linux >= Wheezy just run as root:::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
12
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
13 $ apt-get install python-urwid
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
14
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
15 On other systems urwid may be installed via pip or directly put into the sources
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
16 of getan.
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
17
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
18 Using pip
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
19 ^^^^^^^^^
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
20
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
21 To install urwid via pip run as root::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
22
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
23 $ pip install urwid
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
24
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
25 Or if you prefer using a virtualenv::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
26
414
69ef6f89e930 Prepares release v2.0.
Bernhard Reiter <bernhard@intevation.de>
parents: 367
diff changeset
27 $ virtualenv getan-env
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
28 $ source getan-env/bin/activate
414
69ef6f89e930 Prepares release v2.0.
Bernhard Reiter <bernhard@intevation.de>
parents: 367
diff changeset
29 (getan-env)$ pip install -U pip # to get the latest pip
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
30 (getan-env)$ pip install urwid
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
31
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
32 Using urwid sources
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
33 ^^^^^^^^^^^^^^^^^^^
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
34
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
35 Urwid can be put as source to the getan directory when getan is run directly
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
36 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
37 <https://pypi.python.org/pypi/urwid/>`_.
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
38
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
39 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
40 `<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
41 (sha256sum is
325499a01b65 Use text width of 80 chars per line in README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 337
diff changeset
42 f56568b4f8459b3265c65d9e275ef72df6cb16ad0c291f0feb027cc911ea0f26).::
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
43
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
44 $ 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
45 $ 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
46 $ 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
47 $ 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
48 $ 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
49 $ ln -s $v/urwid urwid
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
50
367
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
51 Install Jinja2
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
52 --------------
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
53
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
54 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
55
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
56 $ apt-get install python-jinja2
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
57
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
58 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
59 sources of getan.
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
60
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
61 Using pip
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
62 ^^^^^^^^^
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
63
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
64 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
65
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
66 $ pip install jinja2
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
67
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
68 Or if you prefer using a virtualenv::
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
69
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
70 $ source getan-env/bin/activate
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
71 (getan-env)$ pip install jinja2
ea5a171abda7 Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents: 342
diff changeset
72
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
73 Install getan
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
74 -------------
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
75
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
76 A installation of getan is not required. It can also be run directly from the
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
77 sources. To install getan system wide the following command must be run as root
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
78 user::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
79
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
80 $ python setup.py install
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
81
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
82 Starting getan
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
83 ==============
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
84
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
85 Getan can be directly run from sources or after a system wide installation from
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
86 the bin dir (e.g. /usr/bin).
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
87
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
88 Running from Sources
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
89 --------------------
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
90
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
91 To run getan from the sources run::
0
7eb7886ed8fd Initial import.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
diff changeset
92
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
93 $ ./getan.py
0
7eb7886ed8fd Initial import.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
diff changeset
94
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
95 or::
0
7eb7886ed8fd Initial import.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
diff changeset
96
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
97 $ ./getan.py /path/to/mytime.db
0
7eb7886ed8fd Initial import.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
diff changeset
98
341
148300d6f126 Fix typos in README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 340
diff changeset
99 to choose a different sqlite3 database then the default time.db
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
100
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
101 The classic version of 'getan' which is based on curses can be run with::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
102
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
103 $ 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
104
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
105 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
106
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
107 $ classic/getan /path/to/mytime.db
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
108
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
109 Running from installation
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
110 -------------------------
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
111
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
112 After installing getan it can be run with::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
113
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
114 $ getan
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
115
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
116 or::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
117
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
118 $ getan /path/to/mytime.db
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
119
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
120 The classic version of 'getan' is also available::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
121
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
122 $ getan-classic
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
123
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
124 or::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
125
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
126 $ 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
127
0ad38a86b1e6 Add vim modeline to REAMDE file
Björn Ricks <bjoern.ricks@intevation.de>
parents: 341
diff changeset
128 # vim: set ts=4 sw=4 tw=80 filetype=rst :
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)