Mercurial > getan
annotate README @ 381:2f9acd073dd3
Include the template in the installed package data
This will ship the default templates in the install getan package. getan-eval.py
will no be able to find and load the default templates.
| author | Björn Ricks <bjoern.ricks@intevation.de> |
|---|---|
| date | Mon, 05 Jan 2015 10:55:28 +0100 |
| parents | ea5a171abda7 |
| children | 69ef6f89e930 |
| 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 |
|
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 | 7 |
| 288 | 8 Install urwid |
| 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 | 11 On Debian GNU/Linux >= Wheezy just run as root::: |
| 12 | |
| 13 $ apt-get install python-urwid | |
| 14 | |
| 15 On other systems urwid may be installed via pip or directly put into the sources | |
| 16 of getan. | |
| 17 | |
| 18 Using pip | |
| 19 ^^^^^^^^^ | |
| 20 | |
| 21 To install urwid via pip run as root:: | |
| 22 | |
| 23 $ pip install urwid | |
| 24 | |
| 25 Or if you prefer using a virtualenv:: | |
| 26 | |
| 27 $ virtuelenv getan-env | |
| 28 $ source getan-env/bin/activate | |
| 29 (getan-env)$ pip install urwid | |
| 30 | |
| 31 Using urwid sources | |
| 32 ^^^^^^^^^^^^^^^^^^^ | |
| 33 | |
| 34 Urwid can be put as source to the getan directory when getan is run directly | |
| 35 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
|
36 <https://pypi.python.org/pypi/urwid/>`_. |
| 288 | 37 |
|
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
|
38 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
|
39 `<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
|
40 (sha256sum is |
|
325499a01b65
Use text width of 80 chars per line in README
Björn Ricks <bjoern.ricks@intevation.de>
parents:
337
diff
changeset
|
41 f56568b4f8459b3265c65d9e275ef72df6cb16ad0c291f0feb027cc911ea0f26).:: |
| 288 | 42 |
| 43 $ 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
|
44 $ 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
|
45 $ 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
|
46 $ 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
|
47 $ 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
|
48 $ ln -s $v/urwid urwid |
| 288 | 49 |
|
367
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
50 Install Jinja2 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
51 -------------- |
|
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 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
|
54 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
55 $ apt-get install python-jinja2 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
56 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
57 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
|
58 sources of getan. |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
59 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
60 Using pip |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
61 ^^^^^^^^^ |
|
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 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
|
64 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
65 $ pip install jinja2 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
66 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
67 Or if you prefer using a virtualenv:: |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
68 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
69 $ source getan-env/bin/activate |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
70 (getan-env)$ pip install jinja2 |
|
ea5a171abda7
Update README for installing jinja2
Björn Ricks <bjoern.ricks@intevation.de>
parents:
342
diff
changeset
|
71 |
| 288 | 72 Install getan |
| 73 ------------- | |
| 74 | |
| 75 A installation of getan is not required. It can also be run directly from the | |
| 76 sources. To install getan system wide the following command must be run as root | |
| 77 user:: | |
| 78 | |
| 79 $ python setup.py install | |
| 80 | |
| 81 Starting getan | |
| 82 ============== | |
| 83 | |
| 84 Getan can be directly run from sources or after a system wide installation from | |
| 85 the bin dir (e.g. /usr/bin). | |
| 86 | |
| 87 Running from Sources | |
| 88 -------------------- | |
| 89 | |
| 90 To run getan from the sources run:: | |
| 0 | 91 |
|
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
|
92 $ ./getan.py |
| 0 | 93 |
| 288 | 94 or:: |
| 0 | 95 |
| 288 | 96 $ ./getan.py /path/to/mytime.db |
| 0 | 97 |
|
341
148300d6f126
Fix typos in README
Björn Ricks <bjoern.ricks@intevation.de>
parents:
340
diff
changeset
|
98 to choose a different sqlite3 database then the default time.db |
| 288 | 99 |
| 100 The classic version of 'getan' which is based on curses can be run with:: | |
| 101 | |
|
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
|
102 $ 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
|
103 |
| 288 | 104 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
|
105 |
| 288 | 106 $ classic/getan /path/to/mytime.db |
| 107 | |
| 108 Running from installation | |
| 109 ------------------------- | |
| 110 | |
| 111 After installing getan it can be run with:: | |
| 112 | |
| 113 $ getan | |
| 114 | |
| 115 or:: | |
| 116 | |
| 117 $ getan /path/to/mytime.db | |
| 118 | |
| 119 The classic version of 'getan' is also available:: | |
| 120 | |
| 121 $ getan-classic | |
| 122 | |
| 123 or:: | |
| 124 | |
| 125 $ 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
|
126 |
|
0ad38a86b1e6
Add vim modeline to REAMDE file
Björn Ricks <bjoern.ricks@intevation.de>
parents:
341
diff
changeset
|
127 # vim: set ts=4 sw=4 tw=80 filetype=rst : |