Git Product home page Git Product logo

poetry-pycharm-plugin's Introduction

Poetry PyCharm Plugin

CI JetBrains IntelliJ plugins JetBrains IntelliJ Plugins license

A JetBrains PyCharm plugin for poetry.

Help

See documentation for more details.

Demo

poetry_demo1

This project is currently in an experimental phase

This plugin supports minimum features to use poetry in PyCharm.

There is feature restrictions.

But, PyCharm team will add a few api to resolve the problem. The detail is in this issue.

The project needs any feedback and PRs. We're waiting for your feedback and PRs.

Quick Installation

The plugin is in JetBrains repository (Poetry Plugin Page)

You can install the stable version on PyCharm's Marketplace (Preference -> Plugins -> Marketplace) Official Document

The plugin requires PyCharm 2020.1 or later (include other JetBrains IDEs)

search plugin

Features

Implemented

  • add a new/existing poetry environment as a interpreter
  • install packages with pyproject.toml when add a interpreter
  • add a new pyproject.toml when it does not exists
  • install and import a package with poetry (QuickFix)
  • install packages from poetry.lock
  • update and lock with a popup
  • show a message and a link to fix settings (QuickFix)
  • install extras and run scripts by clicking a line marker (Toml plugin is required)
  • show a message for outdated version packages (Toml plugin is required)

Workaround

If the plugin does not detect your poetry environment after changing the environment, then please re-open the project.

I think this problem will be resolved by extension points in the future.

Feature Restrictions

The plugin can't provide some features for technical reasons.

Because PyCharm has not provided APIs to support third-party python package managers yet. (a.k.a extension points)

We will be able to implement the following features when JetBrains add extension points to PyCharms.

  • Create a new environment when creating a new project.
  • Use the Custom Icon for poetry.
  • Install/uninstall a package from GUI(settings)
  • And more.

Motivation

Poetry is a popular package manager of python.

However, PyCharm doesn't support poetry.

This plugin support poetry. This source code was forked from the Pipenv integration code in IntelliJ-community.

In this issue PY-30702, the feature is discussing. But, We need time to get the proper functionality in PyCharm.

The plugin has useful features like installing from poetry.lock.(you can watch demo video)

However, The feature is limited. PyCharm has to provided extension points for perfect features.

I guess if the plugin be used a lot of people, then JetBrains developers will implement extension points or poetry integration in PyCharm.

Screen Shots

add_package new_sdk installed_package run_config update_lock quick_fix install_from_lock_file install_extras

Contribute

We are waiting for your contributions to poetry-pycharm-plugin.

Links

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.