Mercurial > getan
annotate README @ 351:b5dc92631561
Allow to load one project and specific entries from the Backend
Add a backend method load_project to allow loading of one project from the
database. Also extend load_entries method to load only entries from a specific
year or calendar week.
| author | Björn Ricks <bjoern.ricks@intevation.de> |
|---|---|
| date | Mon, 03 Mar 2014 14:24:44 +0100 |
| parents | 0ad38a86b1e6 |
| children | ea5a171abda7 |
| 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 |
|
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 | 41 |
| 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 | 48 |
| 49 Install getan | |
| 50 ------------- | |
| 51 | |
| 52 A installation of getan is not required. It can also be run directly from the | |
| 53 sources. To install getan system wide the following command must be run as root | |
| 54 user:: | |
| 55 | |
| 56 $ python setup.py install | |
| 57 | |
| 58 Starting getan | |
| 59 ============== | |
| 60 | |
| 61 Getan can be directly run from sources or after a system wide installation from | |
| 62 the bin dir (e.g. /usr/bin). | |
| 63 | |
| 64 Running from Sources | |
| 65 -------------------- | |
| 66 | |
| 67 To run getan from the sources run:: | |
| 0 | 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 | 70 |
| 288 | 71 or:: |
| 0 | 72 |
| 288 | 73 $ ./getan.py /path/to/mytime.db |
| 0 | 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 | 76 |
| 77 The classic version of 'getan' which is based on curses can be run with:: | |
| 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 | 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 | 83 $ classic/getan /path/to/mytime.db |
| 84 | |
| 85 Running from installation | |
| 86 ------------------------- | |
| 87 | |
| 88 After installing getan it can be run with:: | |
| 89 | |
| 90 $ getan | |
| 91 | |
| 92 or:: | |
| 93 | |
| 94 $ getan /path/to/mytime.db | |
| 95 | |
| 96 The classic version of 'getan' is also available:: | |
| 97 | |
| 98 $ getan-classic | |
| 99 | |
| 100 or:: | |
| 101 | |
| 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 : |