Metadata-Version: 2.4
Name: q2lsp
Version: 3.1.0
Summary: A language server protocol implementation for qiime2.
Author: q2lsp contributors
Maintainer: q2lsp maintainers
License-Expression: MIT
Project-URL: Homepage, https://github.com/geometriccross/q2lsp
Project-URL: Repository, https://github.com/geometriccross/q2lsp
Project-URL: Issues, https://github.com/geometriccross/q2lsp/issues
Keywords: qiime2,lsp,language-server,bioinformatics
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Text Editors :: Integrated Development Environments (IDE)
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: returns<0.27,>=0.26.0
Requires-Dist: pygls<3,>=2.0.0
Dynamic: license-file


# q2lsp
[![quality-gate](https://github.com/geometriccross/q2lsp/actions/workflows/quality-gate.yml/badge.svg)](https://github.com/geometriccross/q2lsp/actions/workflows/quality-gate.yml)
[![vscode-extension-ci](https://github.com/geometriccross/q2lsp/actions/workflows/vscode-extension-ci.yml/badge.svg)](https://github.com/geometriccross/q2lsp/actions/workflows/vscode-extension-ci.yml)
[![agents-md](https://github.com/geometriccross/q2lsp/actions/workflows/agents-md.yml/badge.svg)](https://github.com/geometriccross/q2lsp/actions/workflows/agents-md.yml)

`q2lsp` is a language server protocol (LSP) implementation for QIIME 2 workflows.

![Image](https://raw.githubusercontent.com/geometriccross/q2lsp/refs/heads/images/props/demo_window_captured.gif)

## Getting Started
### Requirements

q2lsp can be installed via [PyPI](https://pypi.org/project/q2lsp/).  
But lsp requires the qiime2 library to be installed in envirnment.

### VSCode Extension
q2lsp is available as a [VS Code extension](./extensions/vscode-q2lsp/README.md).
You can install q2lsp via extension.

### Install Command
```bash
pip install q2lsp
```

## Development

This repository uses Pixi for local development.

```bash
pixi run -e dev pytest
pixi run -e dev ruff check .
pixi run -e dev pyright
```

## VS Code Extension

The extension implementation and usage notes are documented in
`extensions/vscode-q2lsp/README.md`.
