pyls-pop 0.1.0

Python Language Server plugin for POP

python-lsp-server plugin for pop namespace compatibility

About

python-lsp-server is a python implementation of Microsoft’s Language Server Protocol. This plugin is designed to give functionality to the LSP server for python pop projects.

What is POP?

This project is built for pop, a Python-based implementation of Plugin Oriented Programming (POP). POP seeks to bring together concepts and wisdom from the history of computing in new ways to solve modern computing problems.

For more information:

• Intro to Plugin Oriented Programming (POP)

• pop-awesome

• pop-create

Getting Started

Prerequisites

• Python 3.6+

• git (if installing from source, or contributing to the project)

Installation

Note

If wanting to contribute to the project, and setup your local development environment, see the CONTRIBUTING.rst document in the source repository for this project.

If wanting to use pyls-pop, you can do so by either installing from PyPI or from source.

Install from PyPI

pip install pyls-pop

Install from source

# clone repo
git clone [e-mail]:saltstack/pop/pyls-pop.git
cd pyls-pop

# Setup venv
python3 -m venv .venv
source .venv/bin/activate
pip install -e .

Usage

For your convenience, here is where you can find more information on running python-lsp-server in popular IDEs

CLI

After installing pyls-pop, the pylsp command will be available (from the python-lsp-server project). Run with “–help” to see other options available while running this command.

pylsp

vim

Follow the instructions for installing the vim-lsp plugin. Then register the “pylsp” command as a language server. vim-lsp-settings can be used to automate some parts of the process.

PyCharm

Install the Language Server Protocol plugin from the IntelliJ marketplace. Navigate to Pycharm Settings > Language Server Protocol > Server Definitions. Add a new server definition of type “Executable” (The first drop-down menu in the server definition). For the “Extension” use “py”. Add the full path to the “pylsp” command you want to use. Ideally, a version of the command that is in the same python environment as the your source project’s source code.

VSCode

You might have to run pylsp with the “–tcp” and port flags. This is all we have at the moment on implementing in VSCode

Roadmap

Reference the open issues for a list of proposed features (and known issues).

Acknowledgements

• Img Shields for making repository badges easy.