Mercurial > getan
annotate README @ 318:27fc5f43a69b
Move setting the ProjectList and EntryList instances into the controller
It doesn't make sense to pass classes for both to the GetanController
constructor. Be don't have different implementations for these classes.
| author | Björn Ricks <bjoern.ricks@intevation.de> |
|---|---|
| date | Fri, 11 Oct 2013 14:12:03 +0200 |
| parents | a69126bb29e6 |
| children | a3d1fc6c0153 |
| rev | line source |
|---|---|
| 288 | 1 Installation |
| 2 ============ | |
| 0 | 3 |
| 288 | 4 Getan requires `urwid <http://excess.org/urwid>`_ in a version >= 1.0. Urwid is |
| 5 a console user interface library written is 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 | |
| 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 | |
|
291
a69126bb29e6
Update README for installing urwid into getan source
Björn Ricks <bjoern.ricks@intevation.de>
parents:
288
diff
changeset
|
46 $ ln -s urwid-1.1.1/urwid urwid |
| 288 | 47 |
| 48 Install getan | |
| 49 ------------- | |
| 50 | |
| 51 A installation of getan is not required. It can also be run directly from the | |
| 52 sources. To install getan system wide the following command must be run as root | |
| 53 user:: | |
| 54 | |
| 55 $ python setup.py install | |
| 56 | |
| 57 Starting getan | |
| 58 ============== | |
| 59 | |
| 60 Getan can be directly run from sources or after a system wide installation from | |
| 61 the bin dir (e.g. /usr/bin). | |
| 62 | |
| 63 Running from Sources | |
| 64 -------------------- | |
| 65 | |
| 66 To run getan from the sources run:: | |
| 0 | 67 |
|
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
|
68 $ ./getan.py |
| 0 | 69 |
| 288 | 70 or:: |
| 0 | 71 |
| 288 | 72 $ ./getan.py /path/to/mytime.db |
| 0 | 73 |
| 288 | 74 to choose a different sqlite3 database the the defautl time.db |
| 75 | |
| 76 The classic version of 'getan' which is based on curses can be run with:: | |
| 77 | |
|
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
|
78 $ 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
|
79 |
| 288 | 80 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
|
81 |
| 288 | 82 $ classic/getan /path/to/mytime.db |
| 83 | |
| 84 Running from installation | |
| 85 ------------------------- | |
| 86 | |
| 87 After installing getan it can be run with:: | |
| 88 | |
| 89 $ getan | |
| 90 | |
| 91 or:: | |
| 92 | |
| 93 $ getan /path/to/mytime.db | |
| 94 | |
| 95 The classic version of 'getan' is also available:: | |
| 96 | |
| 97 $ getan-classic | |
| 98 | |
| 99 or:: | |
| 100 | |
| 101 $ getan-classic /path/to/mytime.db |