wakapi-anyide

Log your coding time against any WakaTime-like server.

Note

Teenager? Check out High Seas!

I need help!

If you're in the Hack Club Slack, please ask me (Sarah / sharajarajsarahs) for help with using wakapi-anyide with High Seas. Otherwise, open a GitHub issue.

Important

wakapi-anyide is still in development. Please report any tracking bugs!

Alternatives

You should try use an editor extension over wakapi-anyide if you can. If you don't need precise coding metrics, use the WakaTime app instead. The WakaTime app does not work with High Seas.

Quickstart guide for most IDEs

These instructions are best run in an existing project. Make sure to run it in your project directory.

• Create a .wakatime.cfg file if you don't already have one. If you're doing High Seas, you can just run the setup script (and ignore any errors about VS Code not being installed if there are any).

• Set your IDE to autosave as quickly as possible. This is how wakapi-anyide is able to track your coding time. Ideally, something like a second, so it saves as you type. However, anything under your editor timeout preference in your WakaTime settings is fine. For High Seas, your IDE must save at least every two minutes.

• Install wakapi-anyide with your favourite Python package manager (try pipx install wakapi-anyide[color] to install with colour support!)

• Run wakapi-anyide setup and follow the instructions. If you aren't sure, just hit enter for sensible defaults.
  The included paths are the paths that wakapi-anyide will watch for changes.
  The excluded paths are the paths that wakapi-anyide will ignore. You should put things like generated/compiled code or packages there (ie *.o, /node_modules). By default, if you have a .gitignore then it will ignore every file listed in it.

• Inspect and edit the generated wak.toml:

  # https://github.com/iamawatermelo/wakapi-anyide v0.6.8
  
  [meta]
  version = 1
  watchers = ['files']
  
  [files]
  include = ["*"]  # files to include in tracking
  exclude = []  # files to exclude in tracking
  exclude_files = [".gitignore"]  # files whose contents will be used to exclude other files from tracking
  exclude_binary_files = true  # whether to ignore binary files
  # language_mapping = {".kicad_sch" = "Kicad Schematic"}  # custom language mapping
  
  [project]
  name = "test2"  # your project name

• Run wakapi-anyide test in the same directory you have wak.toml in. Ensure that wakapi-anyide is not tracking any generated files by reading through the paths it has cached. If there are no generated files in the cached paths, you're good to go. If there are, edit the include and exclude properties (they use the same format as a gitignore).

• Run wakapi-anyide track to actually track your progress. You must run this every time.

Troubleshooting

Before doing anything else, ensure you're on the latest version of wakapi-anyide. You can find out your current version by running wakapi-anyide version. For pipx, run pipx install --force 'wakapi-anyide[color]'

macOS

The program may fail to watch all files because of macOS' low open file limits. Try:

ulimit -n 12288
wakapi-anyide track

What wakapi-anyide sends

wakapi-anyide tells the WakaTime server:

• your OS and that you are using wakapi-anyide (wakatime/unset (Linux-none-none) wakapi-anyide-wakatime/unset)
• an anonymised hostname based off of your computer's name (anonymised machine 749f8c4e)
• the relative path of the files you change (./wakatime_anyide/__init__.py)
• the estimated time you have spent
• your estimated cursor position over time
• the estimated language of any files you edit (py, Makefile)
• the amount of lines changed
• the branch you are editing if you use Git
• any information you specified in the project section of wak.toml

Additionally, the WakaTime server will be able to see:

• your IP address, which means your approximate location
• the time of day your requests are being sent

Every website you visit can see this information.

wakapi-anyide does not send:

• any information about your system not listed above, like your username
• file content
• filenames outside of those included in your wak.toml

For security, wakapi-anyide does not use wakatime-cli.

Support for existing WakaTime configuration

wakapi-anyide supports the WAKATIME_HOME and the WAKATIME_API_KEY environment variables. The configuration value takes precedence over the environment variable.

$WAKATIME_HOME/.wakatime.cfg

Only these configuration values are supported:

[settings]

option	description	type	default value
api_key	Your WakaTime API key.	string
api_key_vault_cmd	A command to get your api key. Shell syntax is not supported, use sh -c "<your command>" for that.	string
api_url	The WakaTime API base url.	string	https://api.wakatime.com/api/v1
hostname	Optional name of local machine.	string	(an anonymised hostname)
heartbeat_rate_limit_seconds	How often to send heartbeats, in seconds.	int	120

All other configuration values are silently ignored.

.wakatime-project

Not supported.

Quirks and limitations

Tracking

wakapi-anyide is not integrated with your editor. It can only guess what you are doing through file changes. As such, it may sometimes pick up generated files.

By default, any directory beginning with . will be untracked. You cannot change this.

Binary files

wakapi-anyide can track binary files with files.exclude_binary_files = false. File changes are reported specially:

• they are appended with #wakapi-anyide-binary in tracking
• cursor position is set to the last change in the binary file
• the line count are set to the binary diff count

Large files

For performance reasons, files which are larger than 64 KiB will only report changes in filesize.