https://github.com/evroon/github-pycharm

Opens GitHub files in PyCharm
https://github.com/evroon/github-pycharm

firefox github javascript plugin pycharm

Last synced: about 1 month ago
JSON representation

Opens GitHub files in PyCharm

• Host: GitHub
• URL: https://github.com/evroon/github-pycharm
• Owner: evroon
• License: gpl-3.0
• Created: 2022-01-30T19:01:34.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-02-09T20:27:37.000Z (almost 3 years ago)
• Last Synced: 2024-10-27T13:21:00.587Z (3 months ago)
• Topics: firefox, github, javascript, plugin, pycharm
• Language: JavaScript
• Homepage: https://addons.mozilla.org/addon/github-pycharm
• Size: 374 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub PyCharm

This add-on for Firefox adds buttons to GitHub pages that allow you to open files directly in PyCharm. \

Install url: https://addons.mozilla.org/addon/github-pycharm

![preview](icons/preview.png)

## Usage

This add-on adds buttons in GitHub when viewing individual files, comments placed in PRs, the `files changed` tab of PRs and commits.

It will add buttons that, if pressed, open files in PyCharm. If you select a line in GitHub, it will

open the file at the corresponding line number. The first time, PyCharm will ask you to accept opening files from incoming requests, which

must be accepted in order for this add-on to work.

This add-on should actually work for any Jetbrains IDE, not just PyCharm.

**Note**: PyCharm will have to be already opened with the correct project for this add-on to work.

## How it works

When you press the `Open in PyCharm` button, the content script will determine which file and

line number you are trying to open. The content script sends an event to the background script.

The event contains a URL that looks like: `http://localhost:63342/api/file/:`.

The background script sends an HTTP request to this URL. The Jetbrains IDE listens (by default) on this

port and will try to find the file you requested and open it in the IDE.

This feature is documented (not extensively) in [the docs](https://www.jetbrains.com/help/idea/php-built-in-web-server.html#configuring-built-in-web-server).

## Install manually

To install this add-on manually, you have two options:

* Temporarily install the add-on: Go to `about:debugging#/runtime/this-firefox` and click the `Load Temporary Add-On`, and just select one of the files of this repository.

* Permanently install the add-on: Go to `about:addons`, press the settings/gears icon and select `Install Add-on from File...` and select a zipped file of this repository.