Mercurial > getan
annotate README @ 339:435fa7386f51
INTRODUCTION: mentioned key "e" for edit entry. Fixed typo in wizzard.
| author | Bernhard Reiter <bernhard@intevation.de> |
|---|---|
| date | Wed, 29 Jan 2014 17:45:45 +0100 |
| parents | 96a8545eb247 |
| children | 325499a01b65 |
| rev | line source |
|---|---|
| 288 | 1 Installation |
| 2 ============ | |
| 0 | 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 | 6 |
| 288 | 7 Install urwid |
| 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 | 10 On Debian GNU/Linux >= Wheezy just run as root::: |
| 11 | |
| 12 $ apt-get install python-urwid | |
| 13 | |
| 14 On other systems urwid may be installed via pip or directly put into the sources | |
| 15 of getan. | |
| 16 | |
| 17 Using pip | |
| 18 ^^^^^^^^^ | |
| 19 | |
| 20 To install urwid via pip run as root:: | |
| 21 | |
| 22 $ pip install urwid | |
| 23 | |
| 24 Or if you prefer using a virtualenv:: | |
| 25 | |
| 26 $ virtuelenv getan-env | |
| 27 $ source getan-env/bin/activate | |
| 28 (getan-env)$ pip install urwid | |
| 29 | |
| 30 Using urwid sources | |
| 31 ^^^^^^^^^^^^^^^^^^^ | |
| 32 | |
| 33 Urwid can be put as source to the getan directory when getan is run directly | |
| 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 | 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 |
|
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
|
38 `<https://pypi.python.org/packages/source/u/urwid/urwid-1.1.2.tar.gz>`_ (sha256sum is f56568b4f8459b3265c65d9e275ef72df6cb16ad0c291f0feb027cc911ea0f26).:: |
| 288 | 39 |
| 40 $ 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
|
41 $ 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
|
42 $ 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
|
43 $ 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
|
44 $ 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
|
45 $ ln -s $v/urwid urwid |
| 288 | 46 |
| 47 Install getan | |
| 48 ------------- | |
| 49 | |
| 50 A installation of getan is not required. It can also be run directly from the | |
| 51 sources. To install getan system wide the following command must be run as root | |
| 52 user:: | |
| 53 | |
| 54 $ python setup.py install | |
| 55 | |
| 56 Starting getan | |
| 57 ============== | |
| 58 | |
| 59 Getan can be directly run from sources or after a system wide installation from | |
| 60 the bin dir (e.g. /usr/bin). | |
| 61 | |
| 62 Running from Sources | |
| 63 -------------------- | |
| 64 | |
| 65 To run getan from the sources run:: | |
| 0 | 66 |
|
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
|
67 $ ./getan.py |
| 0 | 68 |
| 288 | 69 or:: |
| 0 | 70 |
| 288 | 71 $ ./getan.py /path/to/mytime.db |
| 0 | 72 |
| 288 | 73 to choose a different sqlite3 database the the defautl time.db |
| 74 | |
| 75 The classic version of 'getan' which is based on curses can be run with:: | |
| 76 | |
|
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
|
77 $ 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
|
78 |
| 288 | 79 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
|
80 |
| 288 | 81 $ classic/getan /path/to/mytime.db |
| 82 | |
| 83 Running from installation | |
| 84 ------------------------- | |
| 85 | |
| 86 After installing getan it can be run with:: | |
| 87 | |
| 88 $ getan | |
| 89 | |
| 90 or:: | |
| 91 | |
| 92 $ getan /path/to/mytime.db | |
| 93 | |
| 94 The classic version of 'getan' is also available:: | |
| 95 | |
| 96 $ getan-classic | |
| 97 | |
| 98 or:: | |
| 99 | |
| 100 $ getan-classic /path/to/mytime.db |