Skip to main content

A Python wrapper for the Snoonotes API

Project description


PyPI PyPI license Python Version

Python wrapper for the Snoonotes API

Supported Features:

  1. Fetch notes for a particular user
  2. Fetch Subreddit Notes - Caching implemented
  3. Add notes for a user
  4. Removing usernotes for a user

Depends On:




To use in your python project, use:

from pysnoonotes.core import SnooNotes

Sample Usage

Authenticate using a Reddit account that can add usernotes and a user_key for that account that can be generated from "!/userkey". The generated key is sent via PM to your reddit account.

sn = SnooNotes("username", "user_key")
  1. Returns a dictionary with usernames and their associated usernotes:
notes_for_username = sn.get_notes_for_user("username")
notes_for_usernames12 = sn.get_notes_for_user(["username1", "username2"])
  1. Returns notes supported in that particular subreddit:
subreddit_notes = sn.get_notes_for_subreddit("subreddit")

NOTE: This function caches queries using a pickle file to ./caches directory to prevent repeated API requests. By default it automatically updates caches once a day. However, using use_cache=False, you can manually trigger a call that bypasses cache (this call will also update the cache)

  1. Add a new usernote for the user under a subreddit with a custom note and a link to the comment/post:
sn.add_note_for_user("username", "note_type_id", "subreddit", "Reason for note", "")
  1. Delete a usernote for a given username, given a note_id.

The above is also summarized in the script

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

pysnoonotes-1.1.0.tar.gz (4.5 kB view hashes)

Uploaded source

Built Distribution

pysnoonotes-1.1.0-py3-none-any.whl (6.6 kB view hashes)

Uploaded py3

Supported by

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