Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/c10udburst/pycharm-llm-explainer

Last synced: 23 days ago
JSON representation

Host: GitHub
URL: https://github.com/c10udburst/pycharm-llm-explainer
Owner: C10udburst
Created: 2023-12-18T13:53:37.000Z (11 months ago)
Default Branch: main
Last Pushed: 2024-01-23T15:06:49.000Z (10 months ago)
Last Synced: 2024-05-02T00:06:41.288Z (6 months ago)
Language: Kotlin
Size: 1.78 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        # pycharm-llm-explainer

![Build](https://github.com/C10udburst/pycharm-llm-explainer/workflows/Build/badge.svg)

[![Version](https://img.shields.io/jetbrains/plugin/v/PLUGIN_ID.svg)](https://plugins.jetbrains.com/plugin/PLUGIN_ID)

[![Downloads](https://img.shields.io/jetbrains/plugin/d/PLUGIN_ID.svg)](https://plugins.jetbrains.com/plugin/PLUGIN_ID)

## Template ToDo list

- [x] Create a new [IntelliJ Platform Plugin Template][template] project.

- [x] Get familiar with the [template documentation][template].

- [x] Adjust the [pluginGroup](./gradle.properties), [plugin ID](./src/main/resources/META-INF/plugin.xml) and [sources package](./src/main/kotlin).

- [x] Adjust the plugin description in `README` (see [Tips][docs:plugin-description])

- [x] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html?from=IJPluginTemplate).

- [ ] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time.

- [ ] Set the `PLUGIN_ID` in the above README badges.

- [ ] Set the [Plugin Signing](https://plugins.jetbrains.com/docs/intellij/plugin-signing.html?from=IJPluginTemplate) related [secrets](https://github.com/JetBrains/intellij-platform-plugin-template#environment-variables).

- [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html?from=IJPluginTemplate).

- [ ] Click the Watch button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes.

LLM Explainer is a plugin for PyCharm that allows you to explain python methods by using [ollama.ai](https://ollama.ai/) and open source LLMs.

To use the plugin, simply right click within a python method and select Explain method. This will open a tool window with the explanation.

This plugin needs ollama server to be running, see [ollama-runner.ipynb](./ollama-runner.ipynb) to see how it can be run on Google Colab for example.

To set the ollama server address, go to Settings/Preferences > Tools > Explain with LLM and set the address.

Highlighted Features:

- Dynamic Customization: The plugin's integration with ollama.ai allows users to harness the power of different open-source models, tailoring the experience to their specific needs.

- Flexible Prompting: Users can easily customize the prompt, ensuring that the plugin adapts to diverse coding scenarios.

- Real-time Response Display: The utilization of a tool window ensures that LLM text responses are displayed in real time.

## Installation

- Using the IDE built-in plugin system:

  

  Settings/Preferences > Plugins > Marketplace > Search for "pycharm-llm-explainer" >

  Install

  

- Manually:

  Download the [latest release](https://github.com/C10udburst/pycharm-llm-explainer/releases/latest) and install it manually using

  Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

---

Plugin based on the [IntelliJ Platform Plugin Template][template].

[template]: https://github.com/JetBrains/intellij-platform-plugin-template

[docs:plugin-description]: https://plugins.jetbrains.com/docs/intellij/plugin-user-experience.html#plugin-description-and-presentation