Skip to main content

Python library for the API

Project description

Python library for the API.


Use the library directly:

import instapaperlib

instapaperlib.auth("username", "password")
instapaperlib.add_item("username", "password", "URL", "title")
# with selection test set
instapaperlib.add_item("username", "password", "URL", "title", "selection")

Create an instance to work with:

from instapaperlib import Instapaper

i = Instapaper("username", "password")

Catch the return codes to work with:

from instapaperlib import Instapaper

i = Instapaper("username", "password")
(statuscode, statusmessage) = i.add_item("URL", "title")

Also catch the response header:

from instapaperlib import Instapaper

i = Instapaper("username", "password")
(statuscode, statusmessage, title, location) = i.add_item("URL", "title", response_info=True)

Or use the cli client: -u user -p password -t title URL

If you have set your username:password in ~/.instapaperrc: URL


Install via pip:

pip install instapaperlib

Or, if you must:

easy_install instapaperlib


  • fork the repo
  • add your changes and tests so I don’t accidentally break anything in the future
  • run the tests: python instapaperlib/
  • open a pull request (also runs the tests via Travis CI)
  • high-five yourself, you’re awesome

0.5.1 (2016-01-13)

  • fix travis.yml misconfig that only ran tests on master branch

0.5.0 (2016-01-13)

  • add support for new instapaper API

0.4.0 (2010-09-06)

  • add support for JSONP
  • add support for redirect=close

0.3.1 (2010-06-05)

  • add doctest unit test
  • catch exception in auth because of new query method

0.3.0 (2010-05-24)

  • Choose between HTTP/HTTPS (HTTPS standard)
  • Set selection for added URL
  • proper use of auto-title parameter
  • Response headers (Content-Location, X-Instapaper-Title) are returned

0.2.0 (2010-05-20)

  • Restructured as python package
  • PyPi compatibility
  • Add CLI client

0.1.0 (2010-05-01)

  • Basic library working
  • Working add_item

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
instapaperlib-0.5.1.tar.gz (4.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page