| 1 |
About Gnapsack |
|---|
| 2 |
============== |
|---|
| 3 |
|
|---|
| 4 |
`Gnapsack`_ is a PyGTK-based Linux desktop client for the `Backpack`_ |
|---|
| 5 |
Web Services `API`_. |
|---|
| 6 |
|
|---|
| 7 |
Gnapsack is free software, released under the terms of the `GNU Public |
|---|
| 8 |
License`_ (GPL). |
|---|
| 9 |
|
|---|
| 10 |
See INSTALL.txt for installation instructions, dependencies, etc. |
|---|
| 11 |
|
|---|
| 12 |
.. _Gnapsack: http://www.mattdorn.com/open/gnapsack |
|---|
| 13 |
.. _Backpack: http://www.backpackit.com/ |
|---|
| 14 |
.. _API: http://www.backpackit.com/api/ |
|---|
| 15 |
.. _GNU Public License: http://www.gnu.org/copyleft/gpl.html |
|---|
| 16 |
|
|---|
| 17 |
Requirements |
|---|
| 18 |
============ |
|---|
| 19 |
|
|---|
| 20 |
Gnapsack 0.1 runs only on Linux GTK-based desktops. It was developed |
|---|
| 21 |
on an Ubuntu (Breezy) Linux system, and has not yet been tested on |
|---|
| 22 |
other systems. Ubuntu (Breezy) includes the version 2.8.1 of the |
|---|
| 23 |
python-gtk2 package. |
|---|
| 24 |
|
|---|
| 25 |
The `Zope Object Database`_ (ZODB) is required for local storage. |
|---|
| 26 |
This version of Gnapsack has been tested with `ZODB 3.6.0`_. Your mileage |
|---|
| 27 |
with other versions may vary. |
|---|
| 28 |
|
|---|
| 29 |
.. _Zope Object Database: http://www.zope.org/Wikis/ZODB/FrontPage |
|---|
| 30 |
.. _ZODB 3.6.0: |
|---|
| 31 |
http://www.zope.org/Products/ZODB3.6/ZODB%203.6.0/ZODB3-3.6.0.tgz |
|---|
| 32 |
|
|---|
| 33 |
Usage |
|---|
| 34 |
===== |
|---|
| 35 |
|
|---|
| 36 |
Upon initial startup, you'll need to provide the URL and API token for |
|---|
| 37 |
your Backpack account, as well as the path to a local database file, |
|---|
| 38 |
which will be created if it doesn't exist. |
|---|
| 39 |
|
|---|
| 40 |
You may then either: |
|---|
| 41 |
|
|---|
| 42 |
- Create pages and their child elements (list items, notes, etc.) and |
|---|
| 43 |
save them locally. |
|---|
| 44 |
- Click on the "Connect" button to edit the pages on your Backpack |
|---|
| 45 |
account live. |
|---|
| 46 |
- Use "Sync" to either: |
|---|
| 47 |
- Upload locally created pages to your backpack account, or |
|---|
| 48 |
- Download your live Backpack pages to your local database |
|---|
| 49 |
|
|---|
| 50 |
Version 0.1 Notes |
|---|
| 51 |
================= |
|---|
| 52 |
|
|---|
| 53 |
This is basically a prototype and should not be regarded as a fully |
|---|
| 54 |
usable/mature program. Syncing, for example is very basic: you'll only |
|---|
| 55 |
be able to download Backpack pages to your local database, and upload |
|---|
| 56 |
files created in your local DB to your Backpack account. You won't be |
|---|
| 57 |
able to sync changes between the two. |
|---|
| 58 |
|
|---|
| 59 |
In addition, there's no asynchronous networking, meaning the application |
|---|
| 60 |
will seemingly hang during network communications. |
|---|
| 61 |
|
|---|
| 62 |
There's currently no support for multiple lists--the API supports it but |
|---|
| 63 |
it is not documented in the official documentation. It's described here: |
|---|
| 64 |
http://danontopic.com/public/pages/backpackApiLists.html |
|---|
| 65 |
|
|---|
| 66 |
Reminders are not implemented, because I think there's an iCal interface |
|---|
| 67 |
to them, and therefore another application--your desktop calendar |
|---|
| 68 |
application of choice--can handle them on and offline more effectively |
|---|
| 69 |
than anything Gnapsack would provide. |
|---|
| 70 |
|
|---|
| 71 |
Gnapsack currently runs only on Linux, but other PyGTK applications have |
|---|
| 72 |
been ported to Windows, so hopefully a Windows port will happen soon. |
|---|
| 73 |
|
|---|
| 74 |
The issues mentioned above are among the priorities for version 0.2. |
|---|
| 75 |
|
|---|
| 76 |
I used the `tepache`_ code generation tool, which creates the |
|---|
| 77 |
``SimpleGladeApp.py`` file and inserts callback methods based on your |
|---|
| 78 |
Glade UI model. While it helps you get a PyGTK project under way quickly, |
|---|
| 79 |
it's probably not the best for maintaining a project long-term, and will |
|---|
| 80 |
probably be going away in subsequent versions. |
|---|
| 81 |
|
|---|
| 82 |
.. _tepache: http://primates.ximian.com/~sandino/python-glade/tepache |
|---|
