Skip to main content

Modern Python wrapper for the Instapaper Full API

Project description

instapyper

Modern Python wrapper for the Instapaper Full API.

Features

  • Full type hints (PEP 561 compliant)
  • Both sync and async clients
  • Python 3.10+
  • All API endpoints supported including update_read_progress and set_folder_order

Installation

pip install instapyper
# or
uv add instapyper

Usage

Sync Client

from instapyper import Instapaper

client = Instapaper(consumer_key, consumer_secret)
client.login(username, password)

# Get bookmarks
bookmarks = client.get_bookmarks(limit=10)
for bookmark in bookmarks:
    print(bookmark.title, bookmark.url)

# Add a bookmark
bookmark = client.add_bookmark("https://example.com")

# Star/archive/move
bookmark.star()
bookmark.archive()
bookmark.move(folder_id=12345)

# Get folders
folders = client.get_folders()

Async Client

from instapyper import AsyncInstapaper

async with AsyncInstapaper(consumer_key, consumer_secret) as client:
    await client.login(username, password)

    bookmarks = await client.get_bookmarks(limit=10)
    for bookmark in bookmarks:
        print(bookmark.title)
        await bookmark.star()

Reusing OAuth Tokens

# After login, save tokens for reuse
client.login(username, password)
token = client.oauth_token
secret = client.oauth_token_secret

# Later, login with saved tokens (no password needed)
from instapyper import Instapaper
client = Instapaper(consumer_key, consumer_secret)
client.login_with_token(token, secret)

CLI

pip install instapyper[cli]

instapyper login
instapyper bookmarks list
instapyper bookmarks add https://example.com --tags "tech,ai"
instapyper bookmarks archive 12345 67890
instapyper folders list
instapyper cheatsheet  # more examples

API Coverage

100% coverage of the Instapaper Full API as of January 2026.

Built With

Built with Claude Code (Claude Opus 4.5).

License

MIT

Project details


Download files

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

Source Distribution

instapyper-0.0.1.tar.gz (77.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

instapyper-0.0.1-py3-none-any.whl (23.9 kB view details)

Uploaded Python 3

File details

Details for the file instapyper-0.0.1.tar.gz.

File metadata

  • Download URL: instapyper-0.0.1.tar.gz
  • Upload date:
  • Size: 77.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for instapyper-0.0.1.tar.gz
Algorithm Hash digest
SHA256 77a1f67f835680ecd0efb0d885bf76dbcd4ffde2f8d52b50fc9be49df0426c52
MD5 c0c2856bf4e429e50398e5c70d358177
BLAKE2b-256 adb56dc73a8c8e89b83103b61abb0f530eeb23587693acdf741f8ea5ca6de08a

See more details on using hashes here.

File details

Details for the file instapyper-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: instapyper-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 23.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for instapyper-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 30fffdae8e69c72ca41cd34f317af948694921bbfac2b8f005a339b90f1c7d57
MD5 c820c3479928421f12c3ad5eaf0c3352
BLAKE2b-256 8d13fb0cbc65a32a5bf65ef9f48f950de3bc974f7a67f47e7af44b2ad1945d70

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page