https://github.com/raineszm/pushbullet.jl

A Julia module for using the Pushbullet API (http://pushbullet.com)
https://github.com/raineszm/pushbullet.jl

Last synced: 6 days ago
JSON representation

A Julia module for using the Pushbullet API (http://pushbullet.com)

• Host: GitHub
• URL: https://github.com/raineszm/pushbullet.jl
• Owner: raineszm
• License: other
• Created: 2015-01-05T17:21:49.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2018-10-19T18:42:09.000Z (about 6 years ago)
• Last Synced: 2024-10-30T15:25:16.821Z (about 2 months ago)
• Language: Julia
• Homepage:
• Size: 14.6 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Pushbullet

This module allows users to push data using the [Pushbullet](http://pushbullet.com) service. It requires that the user have a Pushbullet account. The necessary Pushbullet token can be acquired from the [account settings](https://www.pushbullet.com/account) page.

## Access Token

In order to work, Pushbullet.jl expects there to be a file named `.pushbullet.key` in the user's home directory, which contains a single line consisting of their Pushbullet access token. It is recommended that this file be set as only viewable by the current user (`chmod 0600 ~/.pushbullet.key`).

## Usage

The module may be used as follows. Importing loads the access token. The user must then acquire a device id, using the `iden` or `devices` methods, and then Julia objects may be pushed to that device. The Pushbullet API is described in detail [here](http://docs.pushbullet.com).

Pushbullet.jl provides the `push_note`, `push_address`, `push_link`, and `push_address` methods. Their usage should hopefully be clear from the call signatures.

### Getting identifiers

Pushbullet.jl can match devices or identifiers by any of the attributes documented at [on the Pushbullet website](https://docs.pushbullet.com/#devices), comparing by equality, regex, or with a provided predicate function. Calls take the form

```julia

Pushbullet.devices(attr1=matcher1, attr2=matcher2, ...)

Pushbullet.iden(attr1=matcher1, attr2=matcher2, ...)

```

where `matcher1`,`matcher2`, etc., can be a `String`, `Number`, `Regex`, or a `Function` taking the JSON object of the device as an argument. `devices` returns the JSON objects of all devices satisfying the _all of_ the matchers, while `iden` returns the dev id of the first matching device (or an empty string if their is no match).

### Examples

#### Pushing notes

```julia

import Pushbullet

dev_id = Pushbullet.iden(nickname="iPhone")

Pushbullet.push_note(dev_id, title="Test", body="This is a test")

```

```julia

import Pushbullet

devs = Pushbullet.devices()

dev_id = devs[1]["iden"]

Pushbullet.push_link(dev_id, title="Pushbullet.jl", body="This repository",  url="https://github.com/raineszm/pushbullet.jl")

```