Mercurial > getan
comparison README @ 288:1c9c3c9454e3
Update README
Use rst format for README
| author | Björn Ricks <bjoern.ricks@intevation.de> |
|---|---|
| date | Fri, 10 May 2013 10:48:24 +0200 |
| parents | cf905ed23de0 |
| children | a69126bb29e6 |
comparison
equal
deleted
inserted
replaced
| 287:dc251bfba30c | 288:1c9c3c9454e3 |
|---|---|
| 1 1 - install urwid | 1 Installation |
| 2 ============ | |
| 2 | 3 |
| 3 NOTE: getan requires urwid >= 1.0 | 4 Getan requires `urwid <http://excess.org/urwid>`_ in a version >= 1.0. Urwid is |
| 5 a console user interface library written is python. | |
| 4 | 6 |
| 5 On Debian GNU/Linux >= Wheezy just do: | 7 Install urwid |
| 8 ------------- | |
| 6 | 9 |
| 7 # apt-get install python-urwid | 10 On Debian GNU/Linux >= Wheezy just run as root::: |
| 8 | 11 |
| 9 2 - starting getan: | 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 | |
| 35 <https://pypi.python.org/pypi/urwid/>`_ or from the `urwid website | |
| 36 <http://excess.org/urwid/>`_. | |
| 37 | |
| 38 For urwid 1.1.1 the direct download link from pypi is | |
| 39 `<https://pypi.python.org/packages/source/u/urwid/urwid-1.1.1.tar.gz>`_ (md5sum | |
| 40 should be 932d199de6fc847eab2c151512220665).:: | |
| 41 | |
| 42 $ cd getan-source | |
| 43 $ wget https://pypi.python.org/packages/source/u/urwid/urwid-1.1.1.tar.gz | |
| 44 $ md5sum urwid-1.1.1.tar.gz | |
| 45 $ tar xzvf urwid-1.1.1.tar.gz | |
| 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:: | |
| 10 | 66 |
| 11 $ ./getan.py | 67 $ ./getan.py |
| 12 | 68 |
| 13 or | 69 or:: |
| 14 | 70 |
| 15 $ ./getan.py mytime.db | 71 $ ./getan.py /path/to/mytime.db |
| 16 | 72 |
| 17 or (for the classic version of 'getan' based on curses): | 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 | |
| 18 $ classic/getan | 77 $ classic/getan |
| 19 | 78 |
| 20 or | 79 or:: |
| 21 | 80 |
| 22 $ classic/getan mytime.db | 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 |