https://github.com/bragradon/ipython-copilot-completer

Use GitHub Copilot to complete lines in iPython
https://github.com/bragradon/ipython-copilot-completer

copilot github-copilot ipython

Last synced: 24 days ago
JSON representation

Use GitHub Copilot to complete lines in iPython

• Host: GitHub
• URL: https://github.com/bragradon/ipython-copilot-completer
• Owner: bragradon
• License: mit
• Created: 2022-12-18T06:34:36.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-29T01:33:09.000Z (6 months ago)
• Last Synced: 2024-09-29T18:40:14.914Z (about 1 month ago)
• Topics: copilot, github-copilot, ipython
• Language: Python
• Homepage:
• Size: 34.2 KB
• Stars: 31
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# IPython Copilot Completer

IPython Copilot Completer is a plugin for the IPython interactive shell that provides line completion using GitHub Copilot.

## Installation

```bash

# Method 1: wheel

V="0.0.10"

wget https://github.com/bragradon/ipython-copilot-completer/releases/download/v$V/IPython_Copilot_Completer-$V-py3-none-any.whl

pip install IPython_Copilot_Completer-$V-py3-none-any.whl

# Method 2: local install

git clone https://github.com/bragradon/ipython-copilot-completer.git

cd ipython-copilot-completer

pip install -e .

```

Once installed, you can activate the plugin by running the following command in an IPython session:

```python

%load_ext copilot_completer

```

## Configuration

You will need to provide a GitHub Copilot API Token to use IPython Copilot Completer.

You can obtain a token by running the following magic command in an IPython session:

```python

%copilot_login

```

This will open a browser window where you can log in to GitHub and generate a token.

Save the token and set it via the `GITHUB_COPILOT_ACCESS_TOKEN` environment variable so you don't have to login again next time.

## Usage

Suggestions will automatically show up while you're typing. Press right arrow key to accept them.

## License

IPython Copilot Completer is released under the [MIT License](LICENSE).