Slogger
Social logging script for Day One
Install / Use
/learn @ttscoff/SloggerREADME
End of life
Slogger is no longer actively supported. Some parts of it may still work, but there are no guarantees, and as a whole the apps and services it depends on have changed and without active maintenance, it's no longer viable. Thanks for all the love during its development, and please let me know if you know of viable alternatives.
Upgrade Note
If you are upgrading from a version prior to 2.0.12, please remove the RSSLogger section from slogger_config and regenerate it by running slogger again. A new section will be added in addition to RSSLogger called Bloglogger. RSSLogger now logs all entries for the timespan as a single digest entry, whereas Bloglogger loads each item found as an individual "post."
Description
Slogger indexes various public social services and creates Day One (http://dayoneapp.com/) journal entries or plain text Markdown files for them. It allows you to keep a personal journal that collects your online social life automatically, all in one place.
Features
- Slogger 2.x uses a plugin architecture to allow easy extension
- Default plugins:
- Github
- new plugin, supercedes Gist logger.
- Logs push, watch and gist activity
- Flickr
- images uploaded in the last 24 hours, each as an individual post
- Can handle multiple accounts
- Last.fm
- Scrobbled songs for the current day
- updated to grab more songs
- Blog entries
- designed to pull in your blog posts with leading image and excerpt (optionally markdownified).
- Handles multiple feeds
- RSS Feeds
- logs any feed entries for the given timespan as a digest entry
- handles multiple feeds
- Twitter
- Tweets and Favorites for the day as digest entries
- handles multiple Twitter accounts
- Instapaper
- Unread and/or individual folders
- Foursquare
- Checkins for the day
- Pinboard
- Daily digest with descriptions
- optionally include bookmark tags in entry
- Pocket
- Digest list of links---read and unread---posted to Pocket
- Goodreads
- books marked read for the day, one entry each with book cover image, ratings and your review.
- Inserted at the date marked finished.
- App.net
- App.net posts for the current day
- OmniFocus complete tasks for the day
- Github
- There are additional plugins in the default "plugins_disabled" folder. They can be enabled by copying them to your "plugins" folder.
- These are typically disabled by default because they require advanced setup or have limited use for most users. Read the headers in each plugin file for additional details.
- Some of the additional plugins available:
- GetGlue
- Google Analytics (advanced setup)
- Gist
- SoundCloud
- Strava
- untappd (requires untappd gem)
- beer checkins for the day
- Wunderlist new and optionally completed/overdue tasks (see notes for required gems/versions)
- Default plugins:
- Slogger can be called with a single argument that is a path to a local image or text file, and an entry will be created containing its contents.
- You can use this with a folder action or launchd task to add files from a folder connected to something like http://IFTTT.com. Any images added to the watched folder will be turned into journal entries.
- Note that Slogger does not delete the original file, so your script needs to move files out of the folder manually to avoid double-processing.
- You can use this with a folder action or launchd task to add files from a folder connected to something like http://IFTTT.com. Any images added to the watched folder will be turned into journal entries.
- NEW: #tags in posts are saved as native tags. Default tags specified in the config are saved, as well as any hashtags present in the post. Github #XX issue references are ignored.
Install
-
Download and unzip (or clone using git) the Slogger project. It can be stored in your home directory, a scripts folder or anywhere else on your drive.
-
Make sure you have the Xcode command line tools installed. (See Troubleshooting section below.)
-
From the command line, change to the Slogger folder and run the following commands:
sudo gem install bundler bundle install -
Default plugins are stored in
/plugins/, additional plugins are usually found in/plugins_disabled/. Plugins are enabled and disabled by adding/removing them from the/plugins/folder. Move any additional plugins you want to use into/plugins/and disable any other plugins by moving them from/plugins/toplugins_disabled. (Plugins that are found inpluginsbut not configured will not break anything, but you'll see warnings when run.) -
From within the Slogger folder, run
./slogger --update-configto create the initial configuration file. If this doesn't work, you may need to make the file executable:chmod a+x sloggerfrom within the Slogger folder. Note that any time you add new plugins or update existing ones, you'll want to run./slogger --update-configto ensure that your available options are up to date. -
Edit the file
slogger_configthat shows up in your Slogger folder- The required options will be 'storage:', 'image_filename_is_title:', 'date_format:' and 'time_format:'
- storage: should be one of
- ~~'icloud'~~
- For use with Day One 2, use a path like
/Users/[username]/Library/Group Containers/5U8NS4GX82.dayoneapp2/Data/Auto Import/Default Journal.dayone/ - a path to a Dropbox-synced Journal (e.g.
/Users/username/Dropbox/Apps/Day One/Journal.dayone) - a path to a folder for storing markdown files and related images (if the path doesn't end in "Journal.dayone", markdown storage is triggered automatically)
- image_filename_is_title: should be set to true or false. If true, it will use the base filename (without extension) as the title of images imported individually.
- date_format and time_format should be set to your preferred style (strftime)
-
Edit additional configuration options for any plugins defined. The config file is formatted as YAML, and your options need to conform to that syntax. For the most part, you can just maintain the formatting (quotes, dashes, brackets, etc.) of the default settings when updating.
- Note: Some plugins have options that will be filled in automatically. For example, the Twitter plugin requires you to log in on the command line and enter a PIN, after which it completes the authorization and saves your token to the configuration. If you install a plugin which requires oAuth, be sure to run Slogger from the command line with "./slogger -o plugin_name" once to complete the login procedure and save your credentials.
-
Next time you run
./slogger, it will execute the enabled and configured plugins and generate your journal entries.
Usage
- From within the Slogger folder, run
./sloggerto run the data capture for the plugins you have in you/plugins/directory. - Check the output to see if there are any errors occurring. Plugin configuration errors can be ignored, or you can remove offending plugins from the
/plugins/folder (if you don't need them). - If you wish to automate slogger:
- use Lingon, LaunchControl, or other
launchdscheduling app, or... - run
./install.rbto automatically install a launchd task that will run at 11:50pm every night. It's the same as Lingon would create, but all free and stuff.- To uninstall the launchd task, run the command
rm ~/Library/LaunchAgents/com.brettterpstra.slogger.plistand then log out and back in.
- To uninstall the launchd task, run the command
- use Lingon, LaunchControl, or other
Command line options
$ ./slogger -h
Usage: slogger [-dq] [-r X] [/path/to/image.jpg]
--update-config Create or update a slogger_config file. No plugins will be run.
-c, --config FILE Specify alternate configuration file
-d, --develop Develop mode
-h, --help Display this screen
-o, --onlyrun NAME[,NAME2...] Only run plugins matching items in comma-delimited string (partial names ok)
-q, --quiet Run quietly (no notifications/messages)
-r, --retries COUNT Maximum number of retries per plugin (int)
-s, --since-last Set the timespan to the last run date
-t, --timespan DAYS Days of history to collect
-u, --undo COUNT Undo the last COUNT runs
-v, --version Display the version number
Note: You can use the
-soption to only log since the last run date, handy if you want to run Slogger more or less than once per day or are testing plugins.You can also use
-oto run only a certain plugin in the standard plugin directory: just provide it with enough of the name to be unique, e.g.slogger -o gist.The
-u Xoption will undo the last X runs. This works by checking the timestamp of the run and deleting any entries created after that timestamp. It should not be used if you have manually created entries since the last Slogger run. It also does not remove the run timestamps from the list, so running./slogger -u 4will remove the entries created by the last four runs, and then running./slogger -u 5will undo one more run in history.
Updating Slogger
Slogger is currently actively maintained, meaning new fixes and features are regularly available. To update your Slogger installation, download the zip file for the latest version (the link on this page is always current) into a new folder. Copy the new files over existing files to update them. If you've enabled plugins tha
