python-wakatime


Namepython-wakatime JSON
Version 0.0.3 PyPI version JSON
download
home_page
Summarywakatime plugin for python REPLs
upload_time2023-01-14 10:56:37
maintainer
docs_urlNone
author
requires_python>=3.9
licenseGPL v3
keywords wakatime plugin python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # python-wakatime

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Freed-Wu/python-wakatime/main.svg)](https://results.pre-commit.ci/latest/github/Freed-Wu/python-wakatime/main)
[![github/workflow](https://github.com/Freed-Wu/python-wakatime/actions/workflows/main.yml/badge.svg)](https://github.com/Freed-Wu/python-wakatime/actions)
[![codecov](https://codecov.io/gh/Freed-Wu/python-wakatime/branch/main/graph/badge.svg)](https://codecov.io/gh/Freed-Wu/python-wakatime)
[![readthedocs](https://shields.io/readthedocs/python-wakatime)](https://python-wakatime.readthedocs.io)

[![github/downloads](https://shields.io/github/downloads/Freed-Wu/python-wakatime/total)](https://github.com/Freed-Wu/python-wakatime/releases)
[![github/downloads/latest](https://shields.io/github/downloads/Freed-Wu/python-wakatime/latest/total)](https://github.com/Freed-Wu/python-wakatime/releases/latest)
[![github/issues](https://shields.io/github/issues/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/issues)
[![github/issues-closed](https://shields.io/github/issues-closed/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/issues?q=is%3Aissue+is%3Aclosed)
[![github/issues-pr](https://shields.io/github/issues-pr/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/pulls)
[![github/issues-pr-closed](https://shields.io/github/issues-pr-closed/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/pulls?q=is%3Apr+is%3Aclosed)
[![github/discussions](https://shields.io/github/discussions/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/discussions)
[![github/milestones](https://shields.io/github/milestones/all/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/milestones)
[![github/forks](https://shields.io/github/forks/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/network/members)
[![github/stars](https://shields.io/github/stars/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/stargazers)
[![github/watchers](https://shields.io/github/watchers/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/watchers)
[![github/contributors](https://shields.io/github/contributors/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/graphs/contributors)
[![github/commit-activity](https://shields.io/github/commit-activity/w/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/graphs/commit-activity)
[![github/last-commit](https://shields.io/github/last-commit/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/commits)
[![github/release-date](https://shields.io/github/release-date/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/releases/latest)

[![github/license](https://shields.io/github/license/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/blob/main/LICENSE)
[![github/languages](https://shields.io/github/languages/count/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime)
[![github/languages/top](https://shields.io/github/languages/top/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime)
[![github/directory-file-count](https://shields.io/github/directory-file-count/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime)
[![github/code-size](https://shields.io/github/languages/code-size/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime)
[![github/repo-size](https://shields.io/github/repo-size/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime)
[![github/v](https://shields.io/github/v/release/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime)

[![pypi/status](https://shields.io/pypi/status/python-wakatime)](https://pypi.org/project/python-wakatime/#description)
[![pypi/v](https://shields.io/pypi/v/python-wakatime)](https://pypi.org/project/python-wakatime/#history)
[![pypi/downloads](https://shields.io/pypi/dd/python-wakatime)](https://pypi.org/project/python-wakatime/#files)
[![pypi/format](https://shields.io/pypi/format/python-wakatime)](https://pypi.org/project/python-wakatime/#files)
[![pypi/implementation](https://shields.io/pypi/implementation/python-wakatime)](https://pypi.org/project/python-wakatime/#files)
[![pypi/pyversions](https://shields.io/pypi/pyversions/python-wakatime)](https://pypi.org/project/python-wakatime/#files)

[wakatime](https://wakatime.com) plugin for python REPLs.

Supported REPLs:

- [x] [python](https://github.com/python/cpython):
  - executes
    [`str(sys.ps1)`](https://docs.python.org/3/library/sys.html#sys.ps1) after
    every input.
  - configure file:
    [`$PYTHON_STARTUP`](https://docs.python.org/3/using/cmdline.html#envvar-PYTHONSTARTUP).

```python
from python_wakatime.python import install_hook

install_hook()
```

- [x] [ptpython](https://github.com/prompt-toolkit/ptpython):
  - executes `get_ptpython().get_output_prompt()` after every output.
  - configure file: `.../ptpython/config.py`. `...` depends on OS.

```python
from ptpython.repl import PythonRepl
from python_wakatime.ptpython import install_hook


def configure(repl: PythonRepl) -> None:
    install_hook(repl)
```

- [x] [ipython](https://github.com/ipython/ipython):
  - executes
    `c.TerminalInteractiveShell.prompts_class(shell).out_prompt_tokens()` after
    every output.
  - configure file: `~/.ipython/profile_default/ipython_config.py`.

```python
from python_wakatime.iptpython import install_hook

install_hook(c)
```

- [x] [ptipython](https://github.com/prompt-toolkit/ptpython): Same as
  [ipython](https://github.com/ipython/ipython).
- [ ] [bpython](https://github.com/bpython/bpython)
- [ ] [xonsh](https://github.com/xonsh/xonsh)
- [ ] [mypython](https://github.com/asmeurer/mypython): Won't fix.
  - configure file: non-exist.

`install_hook()` must be after customization of prompt string, best at the end
of file.

## Similar projects

- <https://wakatime.com/terminal> lists wakatime plugins for many shells.

See more in [document](https://python-wakatime.readthedocs.io).

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "python-wakatime",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "wakatime,plugin,python",
    "author": "",
    "author_email": "Wu Zhenyu <wuzhenyu@ustc.edu>",
    "download_url": "https://files.pythonhosted.org/packages/9d/40/03dfd05062f5ae99e7d1886d921aa078b67fe410fbbace914dc92766e20b/python-wakatime-0.0.3.tar.gz",
    "platform": null,
    "description": "# python-wakatime\n\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Freed-Wu/python-wakatime/main.svg)](https://results.pre-commit.ci/latest/github/Freed-Wu/python-wakatime/main)\n[![github/workflow](https://github.com/Freed-Wu/python-wakatime/actions/workflows/main.yml/badge.svg)](https://github.com/Freed-Wu/python-wakatime/actions)\n[![codecov](https://codecov.io/gh/Freed-Wu/python-wakatime/branch/main/graph/badge.svg)](https://codecov.io/gh/Freed-Wu/python-wakatime)\n[![readthedocs](https://shields.io/readthedocs/python-wakatime)](https://python-wakatime.readthedocs.io)\n\n[![github/downloads](https://shields.io/github/downloads/Freed-Wu/python-wakatime/total)](https://github.com/Freed-Wu/python-wakatime/releases)\n[![github/downloads/latest](https://shields.io/github/downloads/Freed-Wu/python-wakatime/latest/total)](https://github.com/Freed-Wu/python-wakatime/releases/latest)\n[![github/issues](https://shields.io/github/issues/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/issues)\n[![github/issues-closed](https://shields.io/github/issues-closed/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/issues?q=is%3Aissue+is%3Aclosed)\n[![github/issues-pr](https://shields.io/github/issues-pr/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/pulls)\n[![github/issues-pr-closed](https://shields.io/github/issues-pr-closed/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/pulls?q=is%3Apr+is%3Aclosed)\n[![github/discussions](https://shields.io/github/discussions/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/discussions)\n[![github/milestones](https://shields.io/github/milestones/all/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/milestones)\n[![github/forks](https://shields.io/github/forks/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/network/members)\n[![github/stars](https://shields.io/github/stars/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/stargazers)\n[![github/watchers](https://shields.io/github/watchers/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/watchers)\n[![github/contributors](https://shields.io/github/contributors/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/graphs/contributors)\n[![github/commit-activity](https://shields.io/github/commit-activity/w/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/graphs/commit-activity)\n[![github/last-commit](https://shields.io/github/last-commit/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/commits)\n[![github/release-date](https://shields.io/github/release-date/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/releases/latest)\n\n[![github/license](https://shields.io/github/license/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime/blob/main/LICENSE)\n[![github/languages](https://shields.io/github/languages/count/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime)\n[![github/languages/top](https://shields.io/github/languages/top/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime)\n[![github/directory-file-count](https://shields.io/github/directory-file-count/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime)\n[![github/code-size](https://shields.io/github/languages/code-size/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime)\n[![github/repo-size](https://shields.io/github/repo-size/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime)\n[![github/v](https://shields.io/github/v/release/Freed-Wu/python-wakatime)](https://github.com/Freed-Wu/python-wakatime)\n\n[![pypi/status](https://shields.io/pypi/status/python-wakatime)](https://pypi.org/project/python-wakatime/#description)\n[![pypi/v](https://shields.io/pypi/v/python-wakatime)](https://pypi.org/project/python-wakatime/#history)\n[![pypi/downloads](https://shields.io/pypi/dd/python-wakatime)](https://pypi.org/project/python-wakatime/#files)\n[![pypi/format](https://shields.io/pypi/format/python-wakatime)](https://pypi.org/project/python-wakatime/#files)\n[![pypi/implementation](https://shields.io/pypi/implementation/python-wakatime)](https://pypi.org/project/python-wakatime/#files)\n[![pypi/pyversions](https://shields.io/pypi/pyversions/python-wakatime)](https://pypi.org/project/python-wakatime/#files)\n\n[wakatime](https://wakatime.com) plugin for python REPLs.\n\nSupported REPLs:\n\n- [x] [python](https://github.com/python/cpython):\n  - executes\n    [`str(sys.ps1)`](https://docs.python.org/3/library/sys.html#sys.ps1) after\n    every input.\n  - configure file:\n    [`$PYTHON_STARTUP`](https://docs.python.org/3/using/cmdline.html#envvar-PYTHONSTARTUP).\n\n```python\nfrom python_wakatime.python import install_hook\n\ninstall_hook()\n```\n\n- [x] [ptpython](https://github.com/prompt-toolkit/ptpython):\n  - executes `get_ptpython().get_output_prompt()` after every output.\n  - configure file: `.../ptpython/config.py`. `...` depends on OS.\n\n```python\nfrom ptpython.repl import PythonRepl\nfrom python_wakatime.ptpython import install_hook\n\n\ndef configure(repl: PythonRepl) -> None:\n    install_hook(repl)\n```\n\n- [x] [ipython](https://github.com/ipython/ipython):\n  - executes\n    `c.TerminalInteractiveShell.prompts_class(shell).out_prompt_tokens()` after\n    every output.\n  - configure file: `~/.ipython/profile_default/ipython_config.py`.\n\n```python\nfrom python_wakatime.iptpython import install_hook\n\ninstall_hook(c)\n```\n\n- [x] [ptipython](https://github.com/prompt-toolkit/ptpython): Same as\n  [ipython](https://github.com/ipython/ipython).\n- [ ] [bpython](https://github.com/bpython/bpython)\n- [ ] [xonsh](https://github.com/xonsh/xonsh)\n- [ ] [mypython](https://github.com/asmeurer/mypython): Won't fix.\n  - configure file: non-exist.\n\n`install_hook()` must be after customization of prompt string, best at the end\nof file.\n\n## Similar projects\n\n- <https://wakatime.com/terminal> lists wakatime plugins for many shells.\n\nSee more in [document](https://python-wakatime.readthedocs.io).\n",
    "bugtrack_url": null,
    "license": "GPL v3",
    "summary": "wakatime plugin for python REPLs",
    "version": "0.0.3",
    "split_keywords": [
        "wakatime",
        "plugin",
        "python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a564eb443f7de4ba12c16331aee40fb92d6139620efd2955bba036e669399252",
                "md5": "3e759a27f53ce624c52d6ef429f83b20",
                "sha256": "b06945bc30107bf57c733832848c142021071b19ebe43fc6bf9367b5945e3064"
            },
            "downloads": -1,
            "filename": "python_wakatime-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3e759a27f53ce624c52d6ef429f83b20",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 19969,
            "upload_time": "2023-01-14T10:56:35",
            "upload_time_iso_8601": "2023-01-14T10:56:35.325940Z",
            "url": "https://files.pythonhosted.org/packages/a5/64/eb443f7de4ba12c16331aee40fb92d6139620efd2955bba036e669399252/python_wakatime-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9d4003dfd05062f5ae99e7d1886d921aa078b67fe410fbbace914dc92766e20b",
                "md5": "49f827e3c9e89314be9c3050e7642a1a",
                "sha256": "5500481f41e4531ab365d305c13ac9a461d0abce2a1d661353fba033934c233b"
            },
            "downloads": -1,
            "filename": "python-wakatime-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "49f827e3c9e89314be9c3050e7642a1a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 26016,
            "upload_time": "2023-01-14T10:56:37",
            "upload_time_iso_8601": "2023-01-14T10:56:37.026112Z",
            "url": "https://files.pythonhosted.org/packages/9d/40/03dfd05062f5ae99e7d1886d921aa078b67fe410fbbace914dc92766e20b/python-wakatime-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-14 10:56:37",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "python-wakatime"
}
        
Elapsed time: 0.28545s