https://github.com/tatsh/kate-wakatime
Kate plugin to interface with WakaTime
https://github.com/tatsh/kate-wakatime
c-plus-plus kate-editor kf5 macports wakatime
Last synced: 6 months ago
JSON representation
Kate plugin to interface with WakaTime
- Host: GitHub
- URL: https://github.com/tatsh/kate-wakatime
- Owner: Tatsh
- Created: 2014-11-16T06:53:11.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-06-17T02:47:54.000Z (over 1 year ago)
- Last Synced: 2025-04-06T03:59:50.355Z (7 months ago)
- Topics: c-plus-plus, kate-editor, kf5, macports, wakatime
- Language: C++
- Homepage: https://tatsh.github.io/kate-wakatime/
- Size: 194 KB
- Stars: 12
- Watchers: 2
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Note
This is for Kate 6 (KTextEditor from KF 6).
If you need a version for Kate 5, use the [v1.3.10 release](https://github.com/Tatsh/kate-wakatime/releases).
If you need a version for Kate 4, use the [v0.6 release](https://github.com/Tatsh/kate-wakatime/releases).
## Dependencies
* [CMake](https://cmake.org/)
* [Extra CMake Modules](https://invent.kde.org/frameworks/extra-cmake-modules)
* [KF5:I18n](https://develop.kde.org/products/frameworks/)
* [KF5:TextEditor](https://develop.kde.org/products/frameworks/)
* [Qt5::Sql](https://doc.qt.io/qt-5/qtsql-index.html)
How to install these on your distro is beyond the scope of this document. Generally, install the Kate text editor, CMake, KDE framework development packages, and Qt development packages.
## How to use
1. Get an account at [WakaTime](https://wakatime.com).
2. Get your [API key](https://wakatime.com/settings).
3. Clone this project and compile:
```bash
git clone git@github.com:Tatsh/kate-wakatime.git
cd kate-wakatime
mkdir build
cd build
```
Linux:
```bash
cmake .. -DCMAKE_INSTALL_PREFIX=/usr
```
MacPorts:
```bash
cmake .. -DCMAKE_INSTALL_PREFIX=/opt/local/
```
Finish the task:
```bash
make
sudo make install
```
4. Once this plugin is installed, open Kate and go to _Settings_, _Configure Kate..._, then in the dialog choose _Plugins_.
5. Use the checkbox to enable _WakaTime_ and click _OK_:
6. Restart Kate to be sure the plugin initialises properly.
7. Go to _Settings_, _Configure WakaTime..._. In the dialog, fill in your API key. Click _OK_ to save.
To be certain this will work, check the file at `~/.wakatime.cfg`.
## Is this a keylogger?
Short answer is no.
See the [`WakaTimeView::sendAction()`](https://github.com/Tatsh/kate-wakatime/blob/3c03b3431cf374afeec45dca638f928ab5169bdd/wakatimeplugin.cpp#L268-L423) method if you want to be certain.