1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
.. simplenote.py documentation master file, created by
sphinx-quickstart on Sat Jun 25 17:40:25 2011.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
simplenote.py: python API wrapper for simplenote.com
=========================================================
Contents:
.. toctree::
:maxdepth: 2
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Quickstart
-----------
simplenote.py is a simple wrapper around the simplenote.com web service. It
provides the Simplenote object, with a set of convenience methods to interact
with the service.
First import the module and create an object::
import simplenote
sn = simplenote.Simplenote(user, password)
This object then provides the following API methods::
sn.get_note_list(tags=<Optional list of tags to filter by)
sn.get_note(note_id, version=<Optional integer version number of note to fetch>)
sn.add_note(note)
sn.update_note(note)
sn.trash_note(note_id)
sn.delete_note(note_id)
A ``note`` object is a dictionary with at least a ``content`` property,
containing the note text. The ``update_note`` method needs a note object which
also has a ``key`` property.
API Reference
-------------
If you are looking for information on a specific function, class or
method, you can most likely find it here.
.. toctree::
:maxdepth: 2
api
|
