| Name | zc.buildout.languageserver JSON |
| Version |
0.16.1
JSON |
| download |
| home_page | None |
| Summary | A language server for zc.buildout |
| upload_time | 2025-10-19 12:16:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
===============================================================================
The module, buildout, is a modified version of the zc.buildout package,
which uses the ZPL license:
Zope Public License (ZPL) Version 2.1
A copyright notice accompanies this license document that identifies the
copyright holders.
This license has been certified as open source. It has also been designated as
GPL compatible by the Free Software Foundation (FSF).
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions in source code must retain the accompanying copyright
notice, this list of conditions, and the following disclaimer.
2. Redistributions in binary form must reproduce the accompanying copyright
notice, this list of conditions, and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Names of the copyright holders must not be used to endorse or promote
products derived from this software without prior written permission from the
copyright holders.
4. The right to distribute this software or to use it for any purpose does not
give you the right to use Servicemarks (sm) or Trademarks (tm) of the
copyright
holders. Use of them is covered by separate agreement with the copyright
holders.
5. If any files are modified, you must cause the modified files to carry
prominent notices stating that you changed the files and the date of any
change.
Disclaimer
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESSED
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
| keywords |
buildout
language-server
lsp
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
A [Language Server](https://microsoft.github.io/language-server-protocol/) for [zc.buildout](http://www.buildout.org/).
This language server is implemented using [pygls](https://github.com/openlawlibrary/pygls).
# Installation
## Standalone
Needs a python >= 3.8.
```bash
python -m pip install zc.buildout.languageserver
```
Then configure your editor to run `buildoutls` ( or `python3 -m buildoutls` ).
## From vscode extension
On activation, the extension automatically installs the extension on the python configured in the extension preferences.
The automatic installation does not seem to work with theia and the python egg has to be installed beforehand.
# Features
## Completions
- `${` or `[` complete sections.
- `${section:` complete `section`'s options. If `section` uses a known recipe, dynamic options from the recipe are also completed.
- `${buildout:extends}` completes filenames.
- `${buildout:parts}` and `<=` option completes parts.
## Diagnostics
- non existant section and options in `${section:option}` references.
- required options not defined for a a few "known recipes".
- python package listed in `[versions]` with known vulnerabilities
## Symbols
- Sections and options are shown are displayed in outline as symbols.
## Links
- `${buildout:extends}` are links.
## Go to definitions
- from `${section:options}` we can go to the location where `option` is defined in `section`, or to `section` header if it's not defined.
- from `<= section` we can go to `section`.
- from `${buildout:extends}` we can go to the extended profile.
## Hover
- Hover on an option show the option value.
- Hover on a recipe shows the recipe documentation
## Find references
- Find references of the current symbol. A bit simple, it only look for references and does not check if profiles really `extends` each other. It does not look in templates either.
## Code actions
- update a python package from `[versions]` to its latest version on pypi
- compute the `md5sum` of an url
## Semantic tokens
- python code in options is highlighted.
## Template support
- "current" buildout profile is guessed, then completions and diagnostics should work on any files.
## Jinja2 support
- Jinja syntax is syntax highlighted and jinja syntax markers are ignored when parsing buildout.
## SlapOS support
- SlapOS instance buildout (ie. buildout generated by buildout) is understood, `${` and `$${` are treated separatly for completions and diagnostics.
Raw data
{
"_id": null,
"home_page": null,
"name": "zc.buildout.languageserver",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "buildout, language-server, lsp",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/bf/ec/162bafc4394a098c571e25015f28f1d028943c95c4ba09eb98210a149160/zc_buildout_languageserver-0.16.1.tar.gz",
"platform": null,
"description": "A [Language Server](https://microsoft.github.io/language-server-protocol/) for [zc.buildout](http://www.buildout.org/).\n\nThis language server is implemented using [pygls](https://github.com/openlawlibrary/pygls).\n\n# Installation\n\n## Standalone\n\nNeeds a python >= 3.8.\n\n```bash\npython -m pip install zc.buildout.languageserver\n```\n\nThen configure your editor to run `buildoutls` ( or `python3 -m buildoutls` ).\n\n## From vscode extension\n\nOn activation, the extension automatically installs the extension on the python configured in the extension preferences.\n\nThe automatic installation does not seem to work with theia and the python egg has to be installed beforehand.\n\n# Features\n\n## Completions\n\n- `${` or `[` complete sections.\n- `${section:` complete `section`'s options. If `section` uses a known recipe, dynamic options from the recipe are also completed.\n- `${buildout:extends}` completes filenames.\n- `${buildout:parts}` and `<=` option completes parts.\n\n## Diagnostics\n\n- non existant section and options in `${section:option}` references.\n- required options not defined for a a few \"known recipes\".\n- python package listed in `[versions]` with known vulnerabilities\n\n## Symbols\n\n- Sections and options are shown are displayed in outline as symbols.\n\n## Links\n\n- `${buildout:extends}` are links.\n\n## Go to definitions\n\n- from `${section:options}` we can go to the location where `option` is defined in `section`, or to `section` header if it's not defined.\n- from `<= section` we can go to `section`.\n- from `${buildout:extends}` we can go to the extended profile.\n\n## Hover\n\n- Hover on an option show the option value.\n- Hover on a recipe shows the recipe documentation\n\n## Find references\n\n- Find references of the current symbol. A bit simple, it only look for references and does not check if profiles really `extends` each other. It does not look in templates either.\n\n## Code actions\n\n- update a python package from `[versions]` to its latest version on pypi\n- compute the `md5sum` of an url\n\n## Semantic tokens\n\n- python code in options is highlighted.\n\n## Template support\n\n- \"current\" buildout profile is guessed, then completions and diagnostics should work on any files.\n\n## Jinja2 support\n\n- Jinja syntax is syntax highlighted and jinja syntax markers are ignored when parsing buildout.\n\n## SlapOS support\n\n- SlapOS instance buildout (ie. buildout generated by buildout) is understood, `${` and `$${` are treated separatly for completions and diagnostics.\n",
"bugtrack_url": null,
"license": "Permission is hereby granted, free of charge, to any person obtaining a\n copy of this software and associated documentation files (the \"Software\"),\n to deal in the Software without restriction, including without limitation\n the rights to use, copy, modify, merge, publish, distribute, sublicense,\n and/or sell copies of the Software, and to permit persons to whom the\n Software is furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included\n in all copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL\n THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR\n OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,\n ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\n OTHER DEALINGS IN THE SOFTWARE.\n \n ===============================================================================\n \n The module, buildout, is a modified version of the zc.buildout package,\n which uses the ZPL license:\n \n Zope Public License (ZPL) Version 2.1\n \n A copyright notice accompanies this license document that identifies the\n copyright holders.\n \n This license has been certified as open source. It has also been designated as\n GPL compatible by the Free Software Foundation (FSF).\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n 1. Redistributions in source code must retain the accompanying copyright\n notice, this list of conditions, and the following disclaimer.\n \n 2. Redistributions in binary form must reproduce the accompanying copyright\n notice, this list of conditions, and the following disclaimer in the\n documentation and/or other materials provided with the distribution.\n \n 3. Names of the copyright holders must not be used to endorse or promote\n products derived from this software without prior written permission from the\n copyright holders.\n \n 4. The right to distribute this software or to use it for any purpose does not\n give you the right to use Servicemarks (sm) or Trademarks (tm) of the\n copyright\n holders. Use of them is covered by separate agreement with the copyright\n holders.\n \n 5. If any files are modified, you must cause the modified files to carry\n prominent notices stating that you changed the files and the date of any\n change.\n \n Disclaimer\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESSED\n OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES\n OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,\n INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\n PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\n LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n ",
"summary": "A language server for zc.buildout",
"version": "0.16.1",
"project_urls": {
"Changelog": "https://github.com/perrinjerome/vscode-zc-buildout/tree/main/server/CHANGELOG.md",
"Source code": "https://github.com/perrinjerome/vscode-zc-buildout/"
},
"split_keywords": [
"buildout",
" language-server",
" lsp"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d8019c91dcc0244040680a176394932b263f0524e8b1cbba451f46e6a28ff0a2",
"md5": "ca6574b9ac092e606a962ce21636a3aa",
"sha256": "79851f4c9f522e5acc8949e3262bfdaa77698f018a071d5d88dab9444819eea6"
},
"downloads": -1,
"filename": "zc_buildout_languageserver-0.16.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca6574b9ac092e606a962ce21636a3aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 76473,
"upload_time": "2025-10-19T12:16:14",
"upload_time_iso_8601": "2025-10-19T12:16:14.821319Z",
"url": "https://files.pythonhosted.org/packages/d8/01/9c91dcc0244040680a176394932b263f0524e8b1cbba451f46e6a28ff0a2/zc_buildout_languageserver-0.16.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "bfec162bafc4394a098c571e25015f28f1d028943c95c4ba09eb98210a149160",
"md5": "aae279d61c2a0f8038d0f6a31cb92428",
"sha256": "8723c4a6d67707e0b7aee70590762ec074641c7523abefd76f9607c2691b2e8f"
},
"downloads": -1,
"filename": "zc_buildout_languageserver-0.16.1.tar.gz",
"has_sig": false,
"md5_digest": "aae279d61c2a0f8038d0f6a31cb92428",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 71682,
"upload_time": "2025-10-19T12:16:15",
"upload_time_iso_8601": "2025-10-19T12:16:15.982759Z",
"url": "https://files.pythonhosted.org/packages/bf/ec/162bafc4394a098c571e25015f28f1d028943c95c4ba09eb98210a149160/zc_buildout_languageserver-0.16.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-19 12:16:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "perrinjerome",
"github_project": "vscode-zc-buildout",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "zc.buildout.languageserver"
}
