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

https://github.com/insyncwithfoo/ryecharm

The all-in-one PyCharm plugin for Astral-backed Python tools
https://github.com/insyncwithfoo/ryecharm

intellij-plugin pycharm-plugin python ruff rye uv

Last synced: 6 months ago
JSON representation

The all-in-one PyCharm plugin for Astral-backed Python tools

Awesome Lists containing this project

README

          

# RyeCharm

> [!NOTE]
> Disclaimer: This is not an official Astral project.

> [!NOTE]
> This plugin is a work-in-progress.
> It may or may not work.
> Use it at your own risk.

[![Build](https://github.com/InSyncWithFoo/ryecharm/actions/workflows/build.yaml/badge.svg)][5]
[![Docs](https://github.com/InSyncWithFoo/ryecharm/actions/workflows/docs.yaml/badge.svg)][6]
[![Version](https://img.shields.io/jetbrains/plugin/v/25230)][7]
[![Rating](https://img.shields.io/jetbrains/plugin/r/rating/25230)][8]
[![Downloads](https://img.shields.io/jetbrains/plugin/d/25230)][9]

The all-in-one PyCharm plugin for Astral-backed Python tools:
[Ruff][1], [uv][2] and [Rye][3].

## Usage

If you already have Ruff, uv and/or Rye installed,
you can start using this plugin the moment you install it.
The executables will be automatically detected.

See [the documentation][4] for more information.

## Logging

If you use Ruff as a language server via LSP mode,
you are strongly encouraged to enable language server logging.
This will allow corresponding logs to be recorded in `idea.log`
for further analysis should a problem arises.

Add the following line to the Help |
Diagnostic Tools | Debug Log Settings panel:

```text
com.intellij.platform.lsp
```

[1]: https://github.com/astral-sh/ruff
[2]: https://github.com/astral-sh/uv
[3]: https://github.com/astral-sh/rye
[4]: https://insyncwithfoo.github.io/ryecharm

## Installation

This plugin is [available on the Marketplace][7].
You can also download the ZIP files manually from [the Releases tab][10],
[the `build` branch][11] or [the Actions tab][12]
and follow the instructions described [here][13].

Currently supported versions:
2024.3.3 (build 243.24978.46) and later.

## Credits

Parts of this repository were taken or derived from:

* [@alexander-doroshko/intellij-lsp-plugin-example][14]
* [@astral-sh/ruff][1]
* [@astral-sh/rye][3]
* [@astral-sh/uv][2]
* [@JetBrains/intellij-community][15]
* [@JetBrains/intellij-platform-plugin-template][16]
* [@koxudaxi/poetry-pycharm-plugin][17]
* [@koxudaxi/ruff-pycharm-plugin][18]
* [@lensvol/intellij-blackconnect][19]

[5]: https://github.com/InSyncWithFoo/ryecharm/actions/workflows/build.yaml
[6]: https://github.com/InSyncWithFoo/ryecharm/actions/workflows/docs.yaml
[7]: https://plugins.jetbrains.com/plugin/25230/versions
[8]: https://plugins.jetbrains.com/plugin/25230/reviews
[9]: https://plugins.jetbrains.com/plugin/25230
[10]: https://github.com/InSyncWithFoo/ryecharm/releases
[11]: https://github.com/InSyncWithFoo/ryecharm/tree/build
[12]: https://github.com/InSyncWithFoo/ryecharm/actions/workflows/build.yaml
[13]: https://www.jetbrains.com/help/pycharm/managing-plugins.html#install_plugin_from_disk
[14]: https://github.com/alexander-doroshko/intellij-lsp-plugin-example
[15]: https://github.com/JetBrains/intellij-community
[16]: https://github.com/JetBrains/intellij-platform-plugin-template
[17]: https://github.com/koxudaxi/poetry-pycharm-plugin
[18]: https://github.com/koxudaxi/ruff-pycharm-plugin
[19]: https://github.com/lensvol/intellij-blackconnect