Skip to content

niqodea/ropify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ropify: The Simple Rope CLI Wrapper for Editors

Ropify is a CLI tool streamlining the experience of leveraging Rope to refactor Python code, designed to be used as an API for editors like Vim/Neovim1.

Made for developers who prefer a streamlined approach, Ropify is an ideal choice for those hesitant about installing ropevim due to its heavy requirements or vimscript foundation. If you find ropevim's exhaustive features a tad much and are in pursuit of a more minimalist alternative, look no further than Ropify!

Getting Started 🚀

Follow the instructions below to set up ropify:

# Set up a virtual environment for Ropify
python -m venv ~/.venvs/ropify
source ~/.venvs/ropify/bin/activate
# Clone the Ropify repository
git clone https://github.com/niqodea/ropify.git ~/ropify
# Navigate into the cloned directory
cd ~/ropify
# Install Ropify
pip install .
# Ensure Ropify is accessible outside the virtual environment
ln -s $(which ropify) ~/.local/bin/

Ropify should now be set up and ready to use. You can verify the installation with:

ropify --help

After the setup, integrate the commands in nvim-bindings.lua into your Neovim config to use Ropify from your editor.2

Current Commands 🔍

  • ropify move-symbol: Move class or function to another module.
  • ropify move-module: Move module to another package.
  • ropify show-imports: Display all potential imports for a specified name, outputting to stdout.

Footnotes

  1. The CLI's user experience is also influenced by the rope APIs, which are primarily designed with editor integrations in mind.

  2. TODO: Add vimscript bindings.

About

A Simple Rope CLI Wrapper for Editors

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published