Metadata-Version: 2.1
Name: kak-rope
Version: 0.2.0
Summary: Python refactoring actions for kakoune
Home-page: https://git.sr.ht/~dmerej/kak-rope
License: BSD-3-Clause
Author: Dimitri Merejkowsky
Author-email: dimitri@dmerej.info
Requires-Python: >=3.6.2,<4.0.0
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: rope (>=0.19.0,<0.20.0)
Project-URL: Issues, https://todo.sr.ht/~dmerej/kak-rope
Project-URL: Repository, https://git.sr.ht/~dmerej/kak-rope
Description-Content-Type: text/markdown

## kak-rope

Integrating [rope](https://github.com/python-rope/rope) refactoring
library with kakoune.

## Installation

First, install the `kak-rope` binary and its dependencies:

```bash
pipx install kak-rope
```

Then, configure kakoune, for instance using `plug.kak`:


```
plug "git+https://git.sr.ht/~dmerej/kak-rope" config %{
  # Suggested mappings
  declare-user-mode rope
  map global user r ' :enter-user-mode rope<ret>' -docstring 'enter rope mode'
  map global rope a ':rope-add-import ' -docstring 'add import'
}
```

## Usage

See builtin kakoune help. All commands defined in this module starts with `rope-`.

## Contributing

* Install [poetry](https://python-poetry.org/)
* Install required dependencies

```
poetry install
```

Before submitting a change, run the following commands:

```
poetry run invoke lint
```

You can now use [git-send-email](https://git-send-email.io/) and send a patch to  https://lists.sr.ht/~dmerej/kak-rope

