annotate README @ 344:2c7f3bb7b673 1.1

Prepare version for a getan 1.1 release
author Björn Ricks <bjoern.ricks@intevation.de>
date Mon, 03 Mar 2014 10:44:26 +0100
parents 0ad38a86b1e6
children ea5a171abda7
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
a3d1fc6c0153 README updated: New urwid.org homepage and location simplified. Typo fixed.
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
5 a console user interface library written in Python.
261
cf905ed23de0 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 259
diff changeset
6
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
7 Install urwid
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
8 -------------
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
9
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
10 On Debian GNU/Linux >= Wheezy just run as root:::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
11
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
12 $ apt-get install python-urwid
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
13
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
14 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
15 of getan.
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
16
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
17 Using pip
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
18 ^^^^^^^^^
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 To install urwid via pip run as root::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
21
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
22 $ pip install urwid
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
23
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
24 Or if you prefer using a virtualenv::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
25
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
26 $ virtuelenv getan-env
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
27 $ source getan-env/bin/activate
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
28 (getan-env)$ pip install urwid
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
29
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
30 Using urwid sources
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
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
33 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
34 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
35 <https://pypi.python.org/pypi/urwid/>`_.
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
36
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
37 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
38 `<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
39 (sha256sum is
325499a01b65 Use text width of 80 chars per line in README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 337
diff changeset
40 f56568b4f8459b3265c65d9e275ef72df6cb16ad0c291f0feb027cc911ea0f26).::
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
41
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
42 $ 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
43 $ 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
44 $ 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
45 $ 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
46 $ 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
47 $ ln -s $v/urwid urwid
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
48
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
49 Install getan
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
50 -------------
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
51
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
52 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
53 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
54 user::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
55
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
56 $ python setup.py install
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
57
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
58 Starting getan
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
59 ==============
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
60
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
61 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
62 the bin dir (e.g. /usr/bin).
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
63
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
64 Running from Sources
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
65 --------------------
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
66
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
67 To run getan from the sources run::
0
7eb7886ed8fd Initial import.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
diff changeset
68
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
69 $ ./getan.py
0
7eb7886ed8fd Initial import.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
diff changeset
70
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
71 or::
0
7eb7886ed8fd Initial import.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
diff changeset
72
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
73 $ ./getan.py /path/to/mytime.db
0
7eb7886ed8fd Initial import.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
diff changeset
74
341
148300d6f126 Fix typos in README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 340
diff changeset
75 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
76
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
77 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
78
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
79 $ 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
80
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
81 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
82
288
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
83 $ classic/getan /path/to/mytime.db
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 Running from installation
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
86 -------------------------
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 After installing getan it can be run with::
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 $ getan
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
91
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
92 or::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
93
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
94 $ getan /path/to/mytime.db
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
95
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
96 The classic version of 'getan' is also available::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
97
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
98 $ getan-classic
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
99
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
100 or::
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
101
1c9c3c9454e3 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 261
diff changeset
102 $ 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
103
0ad38a86b1e6 Add vim modeline to REAMDE file
Björn Ricks <bjoern.ricks@intevation.de>
parents: 341
diff changeset
104 # 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)