Package: pocketsnack
pocketsnackis a command line application offering various commands to make yourPocketaccount more manageable. You can de-duplicate your list, purge unwanted tags, and hide your enormous 'to be read' list in a special archive so that looking at your list doesn't become paralysing.For help with commands seepocketsnack --help, or checkthe README in the code repository.tl;drmake sure you have installed a compatible Python versionpip install pocketsnack(you may need to usepip3instead)pocketsnack --configAdd your Pocket API consumer key to the config filepocketsnack --authoriseYou are now ready to enjoy using pocketsnack from any directoryGetting startedCreating a Pocket consumer key for your appLog in to Pocket in a web browserGo tohttps://getpocket.com/developerand click 'CREATE NEW APP'Complete the form: you will need all permissions, and the platform should beDesktop (other), orMac.Your new app will show aconsumer key, which you need to paste into the first line in your config file.Creating a configuration fileBefore you can usepocketsnackyou need to create a configuration file. If you run any command (including simplypocketsnackwithout an argument) when your configuration file doesn't exist, a new file will be created and will open in your default application for editingyamlfiles. Youmustcopy in the consumer key referred to above, andmayadjust any other settings.You can adjust most settings, but the defaults should be sensible for most users if you just want to get started.settingtypedescriptionpocket_consumer_keystringthe consumer key provided by Pocket when you register your 'app' (see below)items_per_cycleintegerhow many items you want to bring in to the List from yourtbrarchive when using--lucky_diparchive_tagstringthe tag to use to identify items in your 'to be read' archiveignore_tagslista list of tag names - items with any of these tags will be ignored by--stashand remain in your Pocket Listignore_favesbooleanif set totruefavorited items will be ignored by--stashand remain in your Pocket Listfave_dupesbooleanif set totruethe remaining (original) item will be favorited when duplicates are removed with--dedupereplace_all_tagsbooleanif set totrueall tags will be removed by--stashwhen adding thearchive_tag, except anything inretain_tagsretain_tagslista list of tag names - these tags will not be removed by--purge, nor by--stashifreplace_all_tagsis set totruelongreads_wordcountintegerdetermines how long a 'longread' is.num_videosintegerhow many videos (if there are videos in your list) should be included in each--lucky_dip. This is a subset ofitem_per_cycle, not in addition to the total.num_imagesintegerhow many images (if there are images in your list) should be included in each--lucky_dip. This is a subset ofitem_per_cycle, not in addition to the total.num_longreadsintegerhow many long reads (if there are long reads in your list) should be included in each--lucky_dip. This is a subset ofitem_per_cycle, not in addition to the total. The definition of a long read is determined bylongreads_wordcountpocket_access_tokenstringaccess token required to interact with the Pocket API. This will be updated when you run--authoriseand should not be edited manually.Save and close when you're done. You can edit this file again at any time by runningpocketsnack --config.Authorising your app with a Pocket access tokenPocket uses OAuth to confirm that your app has permission from your user account to do stuff in your account. This means you need to authorise the app before you can do anything else. Once you have copied your app consumer key into the configuration file, runpocketsnack --authoriseto get your token.You should now have a line at the bottom of your config saying something likepocket_access_token: 'aa11bb-zz9900xx'