# simplenote.py: python API wrapper for simplenote.com

Contents:

# Indices and tables

- Index

- Module Index

- Search Page

## 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.

- API
  - Historical Simplenote API - Note Object
  - Simperium API - Note Object
  - Simplenote main class