simplenote 1.0.1

Python library for the simplenote.com API

Introduction

simplenote.py is a python library for the simplenote.com web service.

Installation

Install via pip:

pip install simplenote

Or if you must:

easy_install simplenote

Usage

simplenote.py can be imported into any python module:

import simplenote
simplenote = simplenote.Simplenote(user, password)

The object then provides the following API methods:

simplenote.get_note_list(since=YYYY-MM-DD, tags=[])     # Supports optional `since` parameter that takes "YYYY-MM-DD"
                                                        # date string to return only notes modified since this date.
                                                        # Supports optional `tags` parameter that takes a list of tags
                                                        # to return only notes that contain at least one of these tags.

simplenote.get_note(note_id)                            # note id is value of key `key` in note dict as returned
                                                        # by get_note_list. Supports optional version integer as
                                                        # argument to return previous versions

simplenote.add_note(note)                               # A ``note`` object is a dictionary with at least a
                                                        # ``content`` property, containing the note text.

simplenote.update_note(note)                            # The ``update_note`` method needs a note object which
                                                        # also has a ``key`` property.
simplenote.trash_note(note_id)

simplenote.delete_note(note_id)

Contribute

If you want to contribute:

• Fork the project.

• Make your feature addition or bug fix based on master.

• Run the tests (See below).

• Add tests for your feature if you can and it appropriate. This is important so I don’t break it in a future version unintentionally.

• Commit, do not mess with version.

• Send me a pull request, let me know what tests fail as a result of the changes.

Tests

Before making a pull request or sending a patch it is recommended you run the tests against the most recent version of Python 2 and Python 3. I.e:

python27 tests/test_simplenote.py

and:

python34 tests/test_simplenote.py

Meta

• Bugs

• Continuous Integration

• Docs

History

1.0.1 (2016-01-13)

• I ended up pointing tag v1.0.0 at a re-written commit so need to retag. No changes beyond that.

1.0.0 (2015-11-22)

• I think this is stable and proven enough to be version 1 by now. Can then roll into Simplenote.vim v1.

0.4.0 (2015-03-06)

• Python 2 and 3 compatibility

0.3.8 (2015-02-16)

• Fix version number of deploy, now deploying is working

0.3.7 (2015-02-16)

• Testing deploying to PyPi with a change in credentials

0.3.6 (2015-02-15)

• Testing deploying to PyPi again, changes to .travis.yml

0.3.5 (2015-02-15)

• Testing deploying to PyPi again, this time will use an annotate tag

0.3.4 (2015-02-15)

• Test related changes again (using single instance)

• Also testing deploying to PyPi via Travis

0.3.3 (2014-04-07)

• Minor change to a test, setting it as expected failure.

0.3.2 (2014-04-06)

• update_note uses utf-8 encoding on returned note content

0.3.1 (2013-12-30)

• Minor change to Travis CI PyPi deply details

0.3.0 (2013-12-29)

• Change optional argument for get_note_list() to be “since date” instead of quanity

• Various tweaks to tests and CI in attempt to make more robust

• get_note_list() now supports optional tag argument

• get_note() now supports optional version argument

0.2.0 (2012-06-02)

• Add optional argument for quantity to get_note_list()

• catch HTTPError when fetching notes

• immediately return if note could not be fetched

• trash_note has to succeed for deleting

• add json import fallbacks

0.1.3 (2011-07-17)

• fix display of ‘+’ signs

0.1.2 (2011-07-02)

• improved documentation

• add sphinx docs

0.1.1 (2011-06-25)

• minor changes for pypi

0.1.0 (2011-06-25)

• basic API methods

• get note list

• get single note

• add note

• update note

• trash note

• delete note