Skip to content

Commit

Permalink
docs: wakatime-cli is now auto downloaded
Browse files Browse the repository at this point in the history
  • Loading branch information
AllanChain committed Feb 12, 2024
1 parent 65e1f40 commit 5bed2b4
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,11 @@ A JupyterLab WakaTime extension.

> [!Warning]
>
> This plugin is at a VERY early stage!
> This plugin is at a early stage!
1. Install [wakatime-cli](https://github.com/wakatime/wakatime-cli) on the JupyterLab server machine if you haven't:
1. Execute:

curl -fsSL https://raw.githubusercontent.com/wakatime/vim-wakatime/master/scripts/install_cli.py | python

If the above command doesn't work, download [install_cli.py](https://raw.githubusercontent.com/wakatime/vim-wakatime/master/scripts/install_cli.py) and run it manually with Python 3.
pip install jupyterlab_wakatime

2. Create a `~/.wakatime.cfg` file with contents:

Expand All @@ -27,9 +25,6 @@ A JupyterLab WakaTime extension.

Replace `XXXX` with your actual [api key](https://wakatime.com/settings#apikey).

3. Execute:

pip install jupyterlab_wakatime

## Uninstall

Expand All @@ -41,6 +36,12 @@ pip uninstall jupyterlab_wakatime

## Troubleshoot

If you are having problem installing [wakatime-cli](https://github.com/wakatime/wakatime-cli) on the JupyterLab server machine, try running:

curl -fsSL https://raw.githubusercontent.com/wakatime/vim-wakatime/master/scripts/install_cli.py | python

If the above command doesn't work, download [install_cli.py](https://raw.githubusercontent.com/wakatime/vim-wakatime/master/scripts/install_cli.py) and run it manually with Python 3.

If you don't see the plugin in https://wakatime.com/plugins/status, please enable `debug` setting and check both JupyterLab logs in terminal and `wakatime.log` file.

If you are seeing the frontend extension, but it is not working, check
Expand All @@ -57,10 +58,6 @@ the frontend extension, check the frontend extension is installed:
jupyter labextension list
```

The following content is generated with the template:

---

## Contributing

### Development install
Expand Down

0 comments on commit 5bed2b4

Please sign in to comment.