Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kamaradclimber/habitica-tasks
My collection of helpers to interact with habitica. Synchronization with JIRA tickets, snoozed tasks, ...
https://github.com/kamaradclimber/habitica-tasks
habitica jira todo
Last synced: 21 days ago
JSON representation
My collection of helpers to interact with habitica. Synchronization with JIRA tickets, snoozed tasks, ...
- Host: GitHub
- URL: https://github.com/kamaradclimber/habitica-tasks
- Owner: kamaradclimber
- License: mit
- Created: 2021-04-25T14:55:59.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-11T07:22:05.000Z (almost 2 years ago)
- Last Synced: 2024-11-21T14:09:37.503Z (3 months ago)
- Topics: habitica, jira, todo
- Language: Ruby
- Homepage:
- Size: 54.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Habitica::Tasks
This gem helps to automatize some task patterns in habitica. It starts by scratching my own itch with future tasks.
## Configuration
Create a file `$HOME/.config/habitica-tasks/config.yml` and populate with at least:
```
user_id: xxx-xxx-xxx-xxx-xxxx
api_token: xxx-xxx-xxx-xxx-xxxx
```
## Rate limiting
⚠ Rate limiting is not implemented correctly by our underlying gem so this program can fail with "RestError" if it starts doing a lot of action (like creating many tasks at once). Just wait for 1 minute and resume.
## Future tasks
Some tasks cannot be started before a given time. It's tempting to create them in advance but since we cannot work on them, they'll artificially change color (giving more XP for no good reason).
To create a future task, use habitica interface to create a ToDo and add `[create_on:2021-05-26]` in the description. Then run habitica-tasks binary, it will temporarily move the task as a daily starting on the create date. If you re-run the script on the `create_on` date, the daily will be removed and original ToDo will be created again. (If you don't run the script, the todo will appear anyway, so you can't loose your task).
Tip: run `habitica-tasks` with a timer on your computer/server.
## Late Tasks
For "dailies" having a low frequency (less than once per week), a followup "LATE" task will be created to allow to make it right. Points/streak are already lost but at least you have an opportunity to do your task. If you don't want to do it anyway, just delete the `[LATE]` task.
If a task is not suitable for this feature, just add `task-type:no-followup` tag to the daily.
## Jira tasks
This will synchronize tasks from JIRA assigned to you. It will try to guess the complexity based on Story Point if they are set.
To use this you'll need to add a few fields in your config.yml:
```
jira:
username: '...'
password: '...'
site: 'htps://...'
```
(note: all options supported by https://github.com/sumoheavy/jira-ruby can be passed there)
# Contribute
Contributions are welcomed!
- To contribute a new feature, make sure to create an issue first to describe the feature.
- To contribute a nontrivial bugfix, make sure to create an issue first.
This repository does not have any tests, I'm mostly using for my own usage and I'm not afraid to debug the program once in a while.