Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/meanderingprogrammer/py-requirements.nvim
Neovim plugin that helps manage python requirements.
https://github.com/meanderingprogrammer/py-requirements.nvim
lua neovim neovim-plugin nvim-cmp nvim-plugin
Last synced: 21 days ago
JSON representation
Neovim plugin that helps manage python requirements.
- Host: GitHub
- URL: https://github.com/meanderingprogrammer/py-requirements.nvim
- Owner: MeanderingProgrammer
- License: mit
- Created: 2024-01-23T05:38:34.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-10-10T21:20:37.000Z (about 1 month ago)
- Last Synced: 2024-10-12T22:54:59.905Z (about 1 month ago)
- Topics: lua, neovim, neovim-plugin, nvim-cmp, nvim-plugin
- Language: Lua
- Homepage:
- Size: 2.35 MB
- Stars: 21
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# py-requirements.nvim
Neovim plugin that helps manage python requirements.
https://github.com/user-attachments/assets/d4aef6a7-deed-4c80-8db6-7d1499e11c64
# Features
- Integrated with `nvim-cmp`
- Uses `treesitter` parser to read `requirements.txt`, more robust than ad-hoc parsing
- Displays diagnostics in `normal` mode with warnings for not using latest version
- Cache `pypi` responses within a session to improve performance
- Auto upgrade dependencies when keymaps are configured
- Display package description from PyPI in a floating window with syntax highlighting
- Supports custom `index-url` and `extra-index-url` for finding packages
# Limitations
- Only supports `requirements.txt` files, if there's interest this can be
expanded, more details in [ISSUE-10](https://github.com/MeanderingProgrammer/py-requirements.nvim/issues/10)
- Does not read or otherwise interact with `pip.conf` file
# Dependencies
- neovim `>= 0.10.0`
- [treesitter](https://github.com/nvim-treesitter/nvim-treesitter) parser:
- [requirements](https://github.com/ObserverOfTime/tree-sitter-requirements):
Used to parse `requirements` files
- System dependencies:
- `curl`: Used to call pypi API
# Install
## lazy.nvim
```lua
{
'MeanderingProgrammer/py-requirements.nvim',
dependencies = { 'nvim-treesitter/nvim-treesitter' },
config = function()
require('py-requirements').setup({})
end,
}
```
# Setup
## Configure
Below is the configuration that gets used by default, any part of it can be
modified by the user.
```lua
require('py-requirements').setup({
-- Enabled by default if you do not use `nvim-cmp` set to false
enable_cmp = true,
-- Endpoint used for getting package versions
index_url = 'https://pypi.org/simple/',
-- Fallback endpoint in case 'index_url' fails to find a package
extra_index_url = nil,
-- Specify which file patterns plugin is active on
-- For info on patterns, see :h pattern
file_patterns = { 'requirements.txt' },
-- For available options, see :h vim.lsp.util.open_floating_preview
float_opts = { border = 'rounded' },
filter = {
-- If set to true pull only final release versions, this will ignore alpha,
-- beta, release candidate, post release, and developmental release versions
final_release = false,
-- If set to true (default value) filter out yanked package versions
yanked = true,
},
-- Query to get each module present in a file
requirement_query = '(requirement) @requirement',
-- Query to get information out of each module
module_query = [[
(requirement (package) @name)
(version_spec (version_cmp) @cmp)
(version_spec (version) @version)
]],
})
```
## Set Keymaps
```lua
config = function()
local requirements = require('py-requirements')
vim.keymap.set('n', 'ru', requirements.upgrade, { silent = true, desc = 'Requirements: Upgrade' })
vim.keymap.set('n', 'rU', requirements.upgrade_all, { silent = true, desc = 'Requirements: Upgrade All' })
vim.keymap.set('n', 'rK', requirements.show_description, { silent = true, desc = 'Requirements: Show package description' })
requirements.setup({...})
end
```
## Install `requirements` Parser
```lua
require('nvim-treesitter.configs').setup({
...
ensure_installed = {
...
'requirements',
...
},
...
})
```
## Add Completion Source
```lua
local cmp = require('cmp')
cmp.setup({
...
sources = cmp.config.sources({
...
{ name = 'py-requirements' },
...
}),
...
})
```
## Prioritize `sort_text` Comparator
The ideal (latest to oldest version) ordering is defined by the `sortText`
attribute of each completion item sent to `nvim-cmp`.
By default this comparator has been disabled by `nvim-cmp`. There are various
ways to enable it including at a file type level. Below is an example of enabling
it globally, note that this will likely impact the ordering of other completion sources.
```lua
local cmp = require('cmp')
local compare = require('cmp.config.compare')
cmp.setup({
...
sorting = {
priority_weight = 2,
comparators = {
compare.exact,
compare.score,
compare.sort_text,
compare.offset,
...
},
},
...
})
```
# Testing
```bash
just test
```
# Related Projects
- [crates.nvim](https://github.com/Saecki/crates.nvim): Many ideas were taken from
this project and translated to work with Python modules rather than Rust crates
- [cmp-pypi](https://github.com/vrslev/cmp-pypi): Found this one rather late, similar
idea but built to work with `pyproject.toml` files
# TODO
- Is there a way to configure `nvim-cmp` automatically with `require('cmp.config').set_buffer`,
would likely run as part of `load` autocmd.