No description or website provided.
Ruby
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
huginn_todoist_agent.gemspec

README.md

TodoistAgent

Build Status Gem Version Coverage Status

The Todoist Agent is a plugin for Huginn that integrates it with your Todoist. It allows to create new items, search for already existing items as well as close existing items.

For new items it allows to set the items' due date, project, priority and labels (if you have Todoist Pro version).

Installation

Add this string to your Huginn's .env ADDITIONAL_GEMS configuration:

huginn_todoist_agent
# when only using this agent gem it should look like hits:
ADDITIONAL_GEMS=huginn_todoist_agent

And then execute:

$ bundle

Usage

After installing this Agent plugin in Huginn go to Credentials and add a new entry with name todoist_api_token and enter your Todoist API token there (you can find that in Todoist's web frontend from "Gear Menu" > Todoist Settings > Account tab).

Then create a new agent and select "Todoist Agent" as type, give it a name and pick an event source. Last not least provide some "content", i.e. what you want the new Todoist item to tell. You can either just enter static text or re-use content from the incoming event by using some liquid templating.

Development

Running rake will clone and set up Huginn in spec/huginn to run the specs of the Gem in Huginn as if they would be build-in Agents. The desired Huginn repository and branch can be modified in the Rakefile:

HuginnAgent.load_tasks(branch: '<your branch>', remote: 'https://github.com/<github user>/huginn.git')

Make sure to delete the spec/huginn directory and re-run rake after changing the remote to update the Huginn source code.

After the setup is done rake spec will only run the tests, without cloning the Huginn source again.

This requires a local MySQL server running. Credentials can be configured in spec/huginn/.env.

Contributing

  1. Fork it ( https://github.com/stesie/huginn_todoist_agent/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request