https://github.com/jvllmr/poetry-types

A poetry plugin that adds/removes type stubs as dependencies like the mypy --install-types command.
https://github.com/jvllmr/poetry-types

Last synced: about 15 hours ago
JSON representation

A poetry plugin that adds/removes type stubs as dependencies like the mypy --install-types command.

• Host: GitHub
• URL: https://github.com/jvllmr/poetry-types
• Owner: jvllmr
• License: mit
• Created: 2021-11-19T22:00:35.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-23T05:32:21.000Z (3 days ago)
• Last Synced: 2024-12-23T06:27:06.606Z (3 days ago)
• Language: Python
• Homepage:
• Size: 468 KB
• Stars: 20
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# poetry-types

[![PyPI version](https://badge.fury.io/py/poetry-types.svg)](https://badge.fury.io/py/poetry-types)

[![GitHub license](https://img.shields.io/github/license/jvllmr/poetry-types)](https://github.com/jvllmr/poetry-types/blob/master/LICENSE)

[![GitHub issues](https://img.shields.io/github/issues/jvllmr/poetry-types)](https://github.com/jvllmr/poetry-types/issues)

![PyPI - Downloads](https://img.shields.io/pypi/dd/poetry-types)

![Tests](https://github.com/jvllmr/poetry-types/actions/workflows/main.yml/badge.svg)

## Description

This is a plugin to poetry for the upcoming poetry 1.2 plugin feature.

It installs/removes/updates typing stubs via following commands:

- `poetry types add `

- `poetry types remove `

- `poetry types update `

## Usage examples

- `poetry types add openpyxl` adds `openpyxl` to your project

- `poetry types update` adds `types-openpyxl` if `openpyxl` is present, but `types-openpyxl` is not

- `poetry types update` removes `types-openpyxl` if `types-openpyxl` is present, but `openpyxl` is not

## Installation

Run `poetry self add poetry-types` for global install or run `poetry add -D poetry-types` to use this plugin with your project.

## Usage with pre-commit

```yaml

- repo: https://github.com/jvllmr/poetry-types

  rev: v0.5.1

  hooks:

    - id: poetry-types

```

### poetry-types has to be skipped with pre-commit.ci

```yaml

ci:

  skip: [poetry-types]

```