pylsp-code-actions


Namepylsp-code-actions JSON
Version 0.1.dev4 PyPI version JSON
download
home_pageNone
SummaryHandy code actions for python-lsp-server
upload_time2024-10-09 13:37:24
maintainerNone
docs_urlNone
authorDB InfraGO AG
requires_python>=3.8
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <!--
 ~ Copyright DB InfraGO AG and contributors
 ~ SPDX-License-Identifier: Apache-2.0
 -->

PyLSP Code Actions
==================

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pylsp-code-actions)
![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)
![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)
![Code QA workflow status](https://github.com/DSD-DBS/pylsp-code-actions/actions/workflows/code-qa.yml/badge.svg)

Handy code actions for python-lsp-server

This is a plugin for `python-lsp-server` which adds a few handy code actions
that I always missed:

- [ ] Flip comma or other operand
- [ ] Sort keyword arguments by name
- [ ] Order keyword arguments as in the called function
- [ ] Sort dict literal by keys
- [x] Generate docstring for function/method
- [ ] Add / Remove `Annotated[...]` around a type annotation

Installation
============

Run the following command in the same venv as the server itself:

```bash
pip install pylsp-code-actions
```

If you are using neovim and mason, use:

```vim
:PylspInstall pylsp-code-actions
```

<sub>(I use neovim too btw. I also use Arch btw.)</sub>

To set up a development environment, clone the project and install it in
editable mode, again in the same virtual environment as the server itself:

```sh
git clone https://github.com/DSD-DBS/pylsp-code-actions
cd pylsp-code-actions

source ~/.../pylsp-server-venv/bin/activate  # (replace with the correct path)
pip install -U pip pre-commit
pip install -e .
pre-commit install
git config commit.template .git_commit_template
```

Contributing
============

We'd love to see your bug reports and improvement suggestions! Please take a
look at our [guidelines for contributors](CONTRIBUTING.md) for details.

Licenses
========

This project is compliant with the [REUSE Specification Version
3.0](https://git.fsfe.org/reuse/docs/src/commit/d173a27231a36e1a2a3af07421f5e557ae0fec46/spec.md).

Copyright DB InfraGO AG, licensed under Apache 2.0 (see full text in
[LICENSES/Apache-2.0.txt](LICENSES/Apache-2.0.txt))

Dot-files are licensed under CC0-1.0 (see full text in
[LICENSES/CC0-1.0.txt](LICENSES/CC0-1.0.txt))

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pylsp-code-actions",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "DB InfraGO AG",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/bb/18/ba286f4e2ed778197198922c5d3ecd1c224d5299b984c2ed817fa53cfefd/pylsp_code_actions-0.1.dev4.tar.gz",
    "platform": "any",
    "description": "<!--\n ~ Copyright DB InfraGO AG and contributors\n ~ SPDX-License-Identifier: Apache-2.0\n -->\n\nPyLSP Code Actions\n==================\n\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pylsp-code-actions)\n![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)\n![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)\n![Code QA workflow status](https://github.com/DSD-DBS/pylsp-code-actions/actions/workflows/code-qa.yml/badge.svg)\n\nHandy code actions for python-lsp-server\n\nThis is a plugin for `python-lsp-server` which adds a few handy code actions\nthat I always missed:\n\n- [ ] Flip comma or other operand\n- [ ] Sort keyword arguments by name\n- [ ] Order keyword arguments as in the called function\n- [ ] Sort dict literal by keys\n- [x] Generate docstring for function/method\n- [ ] Add / Remove `Annotated[...]` around a type annotation\n\nInstallation\n============\n\nRun the following command in the same venv as the server itself:\n\n```bash\npip install pylsp-code-actions\n```\n\nIf you are using neovim and mason, use:\n\n```vim\n:PylspInstall pylsp-code-actions\n```\n\n<sub>(I use neovim too btw. I also use Arch btw.)</sub>\n\nTo set up a development environment, clone the project and install it in\neditable mode, again in the same virtual environment as the server itself:\n\n```sh\ngit clone https://github.com/DSD-DBS/pylsp-code-actions\ncd pylsp-code-actions\n\nsource ~/.../pylsp-server-venv/bin/activate  # (replace with the correct path)\npip install -U pip pre-commit\npip install -e .\npre-commit install\ngit config commit.template .git_commit_template\n```\n\nContributing\n============\n\nWe'd love to see your bug reports and improvement suggestions! Please take a\nlook at our [guidelines for contributors](CONTRIBUTING.md) for details.\n\nLicenses\n========\n\nThis project is compliant with the [REUSE Specification Version\n3.0](https://git.fsfe.org/reuse/docs/src/commit/d173a27231a36e1a2a3af07421f5e557ae0fec46/spec.md).\n\nCopyright DB InfraGO AG, licensed under Apache 2.0 (see full text in\n[LICENSES/Apache-2.0.txt](LICENSES/Apache-2.0.txt))\n\nDot-files are licensed under CC0-1.0 (see full text in\n[LICENSES/CC0-1.0.txt](LICENSES/CC0-1.0.txt))\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Handy code actions for python-lsp-server",
    "version": "0.1.dev4",
    "project_urls": {
        "Homepage": "https://github.com/DSD-DBS/pylsp-code-actions"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fee9799280f095a3b13a3afa0df9989d5972f69c44d5afaa3bfc5b794b0dedca",
                "md5": "1d6747d64dff4f860cbf49e833cc7a4a",
                "sha256": "358f10f701c396bf1fe2128cc1060d30e4375dc7340828d4632104b7d7ab6b21"
            },
            "downloads": -1,
            "filename": "pylsp_code_actions-0.1.dev4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1d6747d64dff4f860cbf49e833cc7a4a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 5150,
            "upload_time": "2024-10-09T13:37:23",
            "upload_time_iso_8601": "2024-10-09T13:37:23.050041Z",
            "url": "https://files.pythonhosted.org/packages/fe/e9/799280f095a3b13a3afa0df9989d5972f69c44d5afaa3bfc5b794b0dedca/pylsp_code_actions-0.1.dev4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bb18ba286f4e2ed778197198922c5d3ecd1c224d5299b984c2ed817fa53cfefd",
                "md5": "36c232f55b00c5ec2b80f0d7c401d8d8",
                "sha256": "75765f79c257acce28e0334ea86d83756267095c57f860a56299e934ffd47bc5"
            },
            "downloads": -1,
            "filename": "pylsp_code_actions-0.1.dev4.tar.gz",
            "has_sig": false,
            "md5_digest": "36c232f55b00c5ec2b80f0d7c401d8d8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 19831,
            "upload_time": "2024-10-09T13:37:24",
            "upload_time_iso_8601": "2024-10-09T13:37:24.560812Z",
            "url": "https://files.pythonhosted.org/packages/bb/18/ba286f4e2ed778197198922c5d3ecd1c224d5299b984c2ed817fa53cfefd/pylsp_code_actions-0.1.dev4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-09 13:37:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "DSD-DBS",
    "github_project": "pylsp-code-actions",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pylsp-code-actions"
}
        
Elapsed time: 0.30763s