{"id":13491738,"url":"https://github.com/wakatime/legacy-python-cli","last_synced_at":"2025-09-29T01:30:40.318Z","repository":{"id":9361219,"uuid":"11215061","full_name":"wakatime/legacy-python-cli","owner":"wakatime","description":"Command line interface used by all WakaTime text editor plugins.","archived":true,"fork":false,"pushed_at":"2021-05-03T04:11:25.000Z","size":4775,"stargazers_count":1021,"open_issues_count":68,"forks_count":84,"subscribers_count":32,"default_branch":"master","last_synced_at":"2024-09-27T04:22:34.442Z","etag":null,"topics":["analytics","developer-tools","metrics","productivity","quantified-self","time-tracker","time-tracking"],"latest_commit_sha":null,"homepage":"https://wakatime.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wakatime.png","metadata":{"files":{"readme":"README.rst","changelog":"HISTORY.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-07-06T07:49:30.000Z","updated_at":"2024-09-26T02:42:55.000Z","dependencies_parsed_at":"2022-09-13T03:02:49.594Z","dependency_job_id":null,"html_url":"https://github.com/wakatime/legacy-python-cli","commit_stats":null,"previous_names":[],"tags_count":78,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wakatime%2Flegacy-python-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wakatime%2Flegacy-python-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wakatime%2Flegacy-python-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wakatime%2Flegacy-python-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wakatime","download_url":"https://codeload.github.com/wakatime/legacy-python-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234579583,"owners_count":18855636,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analytics","developer-tools","metrics","productivity","quantified-self","time-tracker","time-tracking"],"created_at":"2024-07-31T19:00:59.807Z","updated_at":"2025-09-29T01:30:38.588Z","avatar_url":"https://github.com/wakatime.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":".. image:: https://travis-ci.org/wakatime/wakatime.svg\n    :target: https://travis-ci.org/wakatime/wakatime\n    :alt: Tests\n\n.. image:: https://ci.appveyor.com/api/projects/status/g9snpluqi8svrgbn/branch/master?svg=true\n    :target: https://ci.appveyor.com/project/alanhamlett/wakatime-jl10s/branch/master\n    :alt: Windows Tests\n\n.. image:: https://coveralls.io/repos/wakatime/wakatime/badge.svg?branch=master\u0026service=github\n    :target: https://coveralls.io/github/wakatime/wakatime?branch=master\n    :alt: Coverage\n\n.. image:: https://img.shields.io/pypi/v/wakatime.svg\n    :target: https://pypi.python.org/pypi/wakatime\n    :alt: Version\n\n.. image:: https://img.shields.io/pypi/pyversions/wakatime.svg\n    :target: https://pypi.python.org/pypi/wakatime\n    :alt: Supported Python Versions\n\n.. image:: https://wakatime.com/badge/github/wakatime/wakatime.svg?branch=master\n    :target: https://wakatime.com/\n    :alt: Code time tracker\n\n\nWakaTime\n========\n\nThis repo is deprecated. Use the Go version of `wakatime-cli \u003chttps://github.com/wakatime/wakatime-cli\u003e`_ instead.\n\nCommand line interface to `WakaTime \u003chttps://wakatime.com/\u003e`_ used by all WakaTime `text editor plugins \u003chttps://wakatime.com/editors\u003e`_.\n\nGo to http://wakatime.com/editors to install the plugin for your text editor or IDE.\n\n\nInstallation\n------------\n\nNote: You shouldn't need to directly use this package unless you are `building your own plugin \u003chttps://wakatime.com/help/misc/creating-plugin\u003e`_ or your text editor's plugin asks you to install the WakaTime CLI manually.\n\nEach `plugin \u003chttps://wakatime.com/editors\u003e`_ installs the WakaTime CLI for you, except for the `Emacs WakaTime plugin \u003chttps://github.com/wakatime/wakatime-mode\u003e`_.\n\nInstall the plugin for your IDE/editor:\n\nhttps://wakatime.com/editors\n\nEach plugin either comes pre-bundled with WakaTime CLI, or downloads the latest version from GitHub for you.\n\n\nUsage\n-----\n\nIf you are building a plugin using the `WakaTime API \u003chttps://wakatime.com/developers/\u003e`_\nthen follow the `Creating a Plugin \u003chttps://wakatime.com/help/misc/creating-plugin\u003e`_\nguide.\n\nFor command line options, run ``wakatime --help``.\n\nSome more usage information is available in the `FAQ \u003chttps://wakatime.com/faq\u003e`_.\n\n\nConfiguring\n-----------\n\nOptions can be passed via command line, or set in the ``$WAKATIME_HOME/.wakatime.cfg``\nconfig file. Command line arguments take precedence over config file settings.\nThe ``$WAKATIME_HOME/.wakatime.cfg`` file is in `INI \u003chttp://en.wikipedia.org/wiki/INI_file\u003e`_\nformat. An example config file with all available options::\n\n    [settings]\n    debug = false\n    api_key = your-api-key\n    hide_file_names = false\n    hide_project_names = false\n    hide_branch_names =\n    exclude =\n        ^COMMIT_EDITMSG$\n        ^TAG_EDITMSG$\n        ^/var/(?!www/).*\n        ^/etc/\n    include =\n        .*\n    include_only_with_project_file = false\n    status_bar_icon = true\n    status_bar_coding_activity = true\n    offline = true\n    proxy = https://user:pass@localhost:8080\n    no_ssl_verify = false\n    ssl_certs_file =\n    timeout = 30\n    hostname = machinename\n    [projectmap]\n    projects/foo = new project name\n    ^/home/user/projects/bar(\\d+)/ = project{0}\n    [git]\n    disable_submodules = false\n\nFor commonly used configuration options, see examples in the `FAQ \u003chttps://wakatime.com/faq\u003e`_.\n\n\nTroubleshooting\n---------------\n\nRead `How to debug the plugins \u003chttps://wakatime.com/faq#debug-plugins\u003e`_.\n\nMake sure to set ``debug=true`` in your ``~/.wakatime.cfg`` file.\n\nCommon log file location in your User ``$WAKATIME_HOME`` directory::\n\n    ~/.wakatime.log\n\nEach plugin also has its own log file:\n\n* **Atom** writes errors to the developer console (View -\u003e Developer -\u003e Toggle Developer Tools)\n* **Brackets** errors go to the developer console (Debug -\u003e Show Developer Tools)\n* **Cloud9** logs to the browser console (View -\u003e Developer -\u003e JavaScript Console)\n* **Coda** logs to ``/var/log/system.log`` so use ``sudo tail -f /var/log/system.log`` in Terminal to watch Coda 2 logs\n* **Eclipse** logs can be found in the Eclipse ``Error Log`` (Window -\u003e Show View -\u003e Error Log)\n* **Emacs** messages go to the *messages* buffer window\n* **Jetbrains IDEs (IntelliJ IDEA, PyCharm, RubyMine, PhpStorm, AppCode, AndroidStudio, WebStorm)** log to ``idea.log`` (`locating IDE log files \u003chttps://intellij-support.jetbrains.com/hc/en-us/articles/207241085-Locating-IDE-log-files\u003e`_)\n* **Komodo** logs are written to ``pystderr.log`` (Help -\u003e Troubleshooting -\u003e View Log File)\n* **Netbeans** logs to it's own log file (View -\u003e IDE Log)\n* **Notepad++** errors go to ``AppData\\Roaming\\Notepad++\\plugins\\config\\WakaTime.log`` (this file is only created when an error occurs)\n* **Sublime** Text logs to the Sublime Console (View -\u003e Show Console)\n* **TextMate** logs to stderr so run TextMate from Terminal to see any errors (`enable logging \u003chttps://github.com/textmate/textmate/wiki/Enable-Logging\u003e`_)\n* **Vim** errors get displayed in the status line or inline (use ``:redraw!`` to clear inline errors)\n* **Visual Studio** logs to the Output window, but uncaught exceptions go to ActivityLog.xml (`more info... \u003chttp://blogs.msdn.com/b/visualstudio/archive/2010/02/24/troubleshooting-with-the-activity-log.aspx\u003e`_)\n* **VS Code** logs to the developer console (Help -\u003e Toggle Developer Tools)\n* **Xcode** type ``sudo tail -f /var/log/system.log`` in a Terminal to view Xcode errors\n\nUseful API Endpoints:\n\n* `List of Plugins and when they were last heard from \u003chttps://wakatime.com/api/v1/users/current/user_agents\u003e`_\n* `List of computers last sending coding activity \u003chttps://wakatime.com/api/v1/users/current/machine_names\u003e`_\n\nUseful Resources:\n\n* `More Troubleshooting Info \u003chttps://wakatime.com/faq#debug-plugins\u003e`_\n* `Official API Docs \u003chttps://wakatime.com/api\u003e`_\n\n\nContributing\n------------\n\nTo install the dev environment::\n\n    virtualenv venv\n    . venv/bin/activate\n    pip install -r dev-requirements.txt\n    pip install tox\n\nBefore contributing a pull request, make sure tests pass::\n\n    tox\n\nThe above will run tests on all Python versions available on your machine.\nTo just run all tests with your current Python version::\n\n    nosetests\n\nTo run only a single test method, specify the test file location, test class,\nand test method. For example, to only run the Git project detection test::\n\n    nosetests tests.test_project:ProjectTestCase.test_git_project_detected\n\nMany thanks to all `contributors \u003chttps://github.com/wakatime/wakatime/blob/master/AUTHORS\u003e`_!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwakatime%2Flegacy-python-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwakatime%2Flegacy-python-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwakatime%2Flegacy-python-cli/lists"}