Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soywod/kronos.vim
A simple task and time manager. Project moved here:
https://github.com/soywod/kronos.vim
datetime python3 task-manager taskwarrior time-manager vim vim-plugin worktime
Last synced: 4 days ago
JSON representation
A simple task and time manager. Project moved here:
- Host: GitHub
- URL: https://github.com/soywod/kronos.vim
- Owner: soywod
- License: mit
- Archived: true
- Created: 2018-05-26T09:51:47.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-11T17:32:32.000Z (about 5 years ago)
- Last Synced: 2024-08-01T20:49:27.086Z (3 months ago)
- Topics: datetime, python3, task-manager, taskwarrior, time-manager, vim, vim-plugin, worktime
- Language: Vim script
- Homepage: https://github.com/unfog-io/unfog-vim
- Size: 201 KB
- Stars: 200
- Watchers: 6
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
⚠️ *Project archived. Have a look at [unfog](https://github.com/unfog-io/unfog-vim), its successor.*
# Kronos.vim [](https://travis-ci.org/soywod/kronos.vim)
A simple task and time manager.
## Table of contents
* [Requirements](#requirements)
* [Usage](#usage)
* [Create](#create)
* [Read](#read)
* [Update](#update)
* [Start/stop](#startstop)
* [Done](#done)
* [Hide done tasks](#hide-done-tasks)
* [Context](#context)
* [Sort](#sort)
* [Worktime](#worktime)
* [Delete](#delete)
* [Backend](#backend)
* [Import](#import)
* [Mappings](#mappings)
* [Contributing](#contributing)
* [Changelog](#changelog)
* [Credits](#credits)
## Requirements
- VIM v8+ or NVIM v0.3.4+ (not tested on lower versions)
- Python v3.3+ (check it with `:echo has('python3')` and `:!python3 --version`)
## Usage
```vim
:Kronos
```
Then you can create, read, update, delete tasks using Vim mapping. The table
will automatically readjust when you save the buffer (`:w`).
### Create
To create a task, you can:
- Write or copy a full table line: `|id|desc|tags|active|due|`
- Follow the Kronos format: ` `
A tag should start by a `+`. You can add as many tags as you need.
A due should start by a `:`. There is 3 kinds of due:
- The absolute due: `:DDMMYY:HHMM`, which correspond to a specific date.
- The approximative due, which is a partial absolute, for eg. `:DD`,
`::HH`, `:DDM:M`. Kronos will try to find the closest date matching this
due.
- The relative due, which is relative to the actual date. For eg. `:1y`,
`:2mo`, `:4h`. Available units: `y, mo, w, d, h, m`.
*Note: unit
order should be respected, from the biggest to the smallest. `2y4mo24m` is
valid, `3m4d` is not.*
Here some use cases:
| Actual date | Given pattern | Due |
| --- | --- | --- |
| 03/03/2019 21:42 | `:4` | 04/03/2019 00:00 |
| 03/03/2019 21:42 | `:2` | 02/04/2019 00:00 |
| 03/03/2019 21:42 | `:0304` or `:034` | 03/04/2019 00:00 |
| 03/03/2019 21:42 | `:3004` or `304` | 30/04/2019 00:00 |
| 03/03/2019 21:42 | `:0202` | 02/02/2020 00:00 |
| 03/03/2019 21:42 | `:020221` | 02/02/2021 00:00 |
| 03/03/2019 21:42 | `::22` | 03/03/2019 22:00 |
| 03/03/2019 21:42 | `::19` | 04/03/2019 19:00 |
| 03/03/2019 21:42 | `:4:2150` | 04/03/2019 21:50 |
| 03/03/2019 21:42 | `:2d` | 05/03/2019 21:42 |
| 03/03/2019 21:42 | `:1w10m` | 10/03/2019 21:52 |
| 03/03/2019 21:42 | `:1y13mo1h` | 03/04/2021 22:42 |
*Note: the date format is DD/MM/YYYY HH:MM*
### Read
To show focused task details, press ``:
### Update
To update a task, just edit the cell and save:
For the `due` field, you need to use the Kronos due format (`:18`,
`:20:1230`, `2w`...).
### Start/stop
To start/stop a task, press ``:
### Done
To mark a task as done, delete the line:
### Hide done tasks
To show/hide done tasks, press `` (for `go hide`):
### Context
The context filters tasks by a list of tags. Once set up:
- You will see only tasks containing at least one tag of your context
- When you [create](#create) a task, all tags in your context will be assigned
to it
To set up a context, press `gc` (for `go to context`), and type all tags you
want in your context (separated by spaces). Typing an empty context removes it:
### Sort
You can sort tasks by pressing `gs` (for ascending) or `gS` (for descending).
The sort depends on the position of the cursor. For eg, if it's in the `ID`
column, it will sort the ids.
*Note: once the tasks sorted, the buffer will be considered as modified, no
matter the result.*
### Worktime
The worktime allows you to check how much time you spent on one or many tags,
grouped by day. Press `gw` (for `go to worktime`), and type the tags you want
to calculate the total worktime:
You can also add a beginning date with `>DDMMYY:HHMM` and a ending date with
`18 <20`: worktime for tag1, tag2 between the 18th and the 20th
of the current month
- `tag1 >:10 `: worktime for tag1 starting at 10AM of the current day
- `tag2 <18:22 `: worktime for tag2 ending at 10PM of the 18th of the current
month
### Delete
To delete a task, delete the line when [done tasks are
shown](#hide-done-tasks):
## Backend
By default, Kronos stores tasks in a file
(`/path/to/vim/pluggins/kronos.vim/.database`). You can define an additionnal
backend (for now, only Taskwarrior is available):
```vim
let g:kronos_backend = 'file' | 'taskwarrior'
```
This way, tasks will be synchronized with Taskwarrior. It means you can manage
basic actions with Kronos, and manage advanced ones with Taskwarrior CLI.
*Note: the synchronization is only from Kronos to Taskwarrior. To synchronize
from Taskwarrior to Kronos, check the [import section below](#import).*
## Import
If you want to import your Taskwarrior tasks into Kronos, you can use the
`import.py` script at the root folder of the plugin. Usage:
```bash
./import.py taskwarrior ./path/to/your/backlog.data
```
*Note: this will erase the current database*
## Mappings
Here the default mappings:
| Function | Mapping |
| --- | --- |
| Toggle task | `` |
| [Show task infos](#read) | `K` |
| [Set context](#context) | `gc` |
| [Sort (asc)](#sort) | `gs` |
| [Sort (desc)](#sort) | `gS` |
| [Hide/show done tasks](#hide-done-tasks) | `gh` |
| [Show worktime](#worktime) | `gw` |
| Jump to the next cell | `` |
| Jump to the prev cell | `` |
| Delete in cell | `dic` |
| Change in cell | `cic` |
| Visual in cell | `vic` |
You can customize them:
```vim
nmap (kronos-toggle)
nmap K (kronos-info)
nmap gc (kronos-context)
nmap gs (kronos-sort-asc)
nmap gS (kronos-sort-desc)
nmap gh (kronos-hide-done)
nmap gw (kronos-worktime)
nmap (kronos-next-cell)
nmap (kronos-prev-cell)
nmap dic (kronos-delete-in-cell)
nmap cic (kronos-change-in-cell)
nmap vic (kronos-visual-in-cell)
```
## Contributing
Git commit messages follow the [Angular
Convention](https://gist.github.com/stephenparish/9941e89d80e2bc58a153), but
contain only a subject.
> Use imperative, present tense: “change” not “changed” nor
> “changes”
Don't capitalize first letter
No dot (.) at the end
Code should be as clean as possible, variables and functions use the snake case
convention. A line should never contain more than `80` characters.
Tests should be added for each new functionality. Be sure to run tests before
proposing a pull request.
## Changelog
- **Jul. 24, 2019** - Add tasks sorting
- **Jul. 23, 2019** - Add option to use Taskwarrior as backend
- **May. 14, 2019** - Add relative due + rewrite datetime part in python3
- **May. 13, 2019** - Add custom mapping
- **May. 12, 2019** - Add script to import tasks from taskwarrior (thanks to [KevCui](https://github.com/KevCui))
- **May. 11, 2019** - Remove sync support due to too many complications
- **Dec. 31, 2018** - Worktime is now calculated also per day
- **Dec. 26, 2018** - Refactor interface
([Vimwiki](https://github.com/vimwiki/vimwiki) like)
- **Oct. 18, 2018** - ~Refactor code to match the [Kronos
protocol](https://github.com/soywod/kronos)~
- **Jul. 05, 2018** - Add context by tags
- **Jun. 26, 2018** - ~Implement Gist sync feature~
- **Jun. 25, 2018** - Add ability to mark tasks as undone
- **Jun. 24, 2018** - Add option to show or hide done tasks
- **Jun. 23, 2018** - Init changelog
## Credits
- [Taskwarrior](https://taskwarrior.org), a task manager
- [Timewarrior](https://taskwarrior.org/docs/timewarrior), a time manager
- [vim-taskwarrior](https://github.com/blindFS/vim-taskwarrior), a
Taskwarrior wrapper for vim
- [Vimwiki](https://github.com/vimwiki/vimwiki)