poetry-exec-plugin
A plugin for poetry that allows you to execute scripts defined in your pyproject.toml, just like you can in npm or pipenv
Installation
Installation requires poetry 1.2.0+. To install this plugin run:
pip install poetry-exec-plugin
For other methods of installing plugins see the poetry documentation.
Usage
To use this plugin, first define the scripts that you wish to be able to execute in your pyproject.toml file under a section called tool.poetry-exec-plugin.commands. For example:
[tool.poetry-exec-plugin.commands]
hello-world = "TEXT=hello-world; echo $TEXT"
lint = "flake8"
This will define a script that you can then execute with the cleo library has built-in support for terminal colors, and already defines semantic styles, s.a, Using self.line and self.line_error Tested locally by pulling the plugin with Here is how an info message is rendered under Gnome terminal: And this is how an error message looks like:
Hi, thanks for this utility, looks promising! I've found a bug that stucks me sometimes, so I've decided to submit a patch. If you create a command like: You can't pass it strings with spaces because the words after the space are not properly passed to the command: This turns many commands unusable. For example is not possible to execute a So this fixes it using I've rewritten the test suite to remove mocks and because Bumps certifi from 2022.6.15 to 2022.12.7. Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting You can trigger Dependabot actions by commenting on this PR: You can disable automated security fix PRs for this repo from the Security Alerts page. For example if I execute It would show something like: Really cool and promising plugin! Is it possible to specify the plugin installation from the project's That way, we wouldn't have to specify the plugin as a requirement in our CI builders and dev-machine setup, and simply be allowed to do (whether or not the plugin is installed) : Thanks! Full Changelog: https://github.com/keattang/poetry-exec-plugin/compare/0.3.4...0.3.5 Full Changelog: https://github.com/keattang/poetry-exec-plugin/compare/0.3.3...0.3.4 Full Changelog: https://github.com/keattang/poetry-exec-plugin/compare/0.3.2...0.3.3 Full Changelog: https://github.com/keattang/poetry-exec-plugin/compare/0.3.1...0.3.2 Running commands from the pyproject.toml directory Updated install instructions Initial releasepoetry exec
Comments
Drop simple-chalk dependency
info, comment, question and error.style argument we can drop the dependency on simple-chalk library, as it is only being used to display error messages in red, and info messages in dim.poetry self add https://github.com/ajcerejeira/poetry-exec-plugin.git.
Fix arguments propagation to commands
[tool.poetry-exec-plugin.commands]
printf = "printf"
$ poetry exec printf -- 'Hello world\n'
Exec: printf Hello world\n
Hello<my-user>@<myenv>
pytest test that have spaces in their id:[tool.poetry-exec-plugin.commands]
test = "pytest"
[tool.poetry-exec-plugin.commands]
$ poetry exec test -- -svv 'tests/path/to/test.py::test_name[my id]'
Exec: poetry exec test -- -svv 'tests/path/to/test.py::test_name[my id]'
===== test session starts =====
platform linux -- Python 3.7.13, pytest-7.1.2, pluggy-1.0.0 -- /my/python
cachedir: .pytest_cache
rootdir: ..., configfile: pyproject.toml
plugins: cov-3.0.0
collected 0 items
===== no tests ran in 0.01s =====
ERROR: file or directory not found: id]
shlex.join, with a backport for Python3.7 that should be removed when that version reaches their EOL.cleo.testers.command_tester.CommandTester does not allow to pass arguments to commands.
Bump certifi from 2022.6.15 to 2022.12.7
Commits
9e9e840 2022.12.07b81bdb2 2022.09.24939a28f 2022.09.14aca828a 2022.06.15.2de0eae1 Only use importlib.resources's new files() / Traversable API on Python ≥3.11 ...b8eb5e9 2022.06.15.147fb7ab Fix deprecation warning on Python 3.11 (#199)b0b48e0 fixes #198 -- update link in license
@dependabot rebase.
Dependabot commands and options
@dependabot rebase will rebase this PR@dependabot recreate will recreate this PR, overwriting any edits that have been made to it@dependabot merge will merge this PR after your CI passes on it@dependabot squash and merge will squash and merge this PR after your CI passes on it@dependabot cancel merge will cancel a previously requested merge and block automerging@dependabot reopen will reopen this PR if it is closed@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)@dependabot use these labels will set the current labels as the default for future PRs for this repo and language@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language
Suggest correct command if other command is very similar
poetry exec docs and a doc command exists, instead of showing this error (current):$ poetry exec docs
Unable to find the command 'docs'. To configure a command you must add it to your pyproject.toml under the path [tool.poetry-exec-plug
in.commands]. For example:
[tool.poetry-exec-plugin.commands]
docs = "echo Hello World"
$ poetry exec docs
Unable to find the command 'docs'. Perhaps you wanted to run the 'doc' command?
npm output
$ npm run docs
npm ERR! Missing script: "docs"
npm ERR!
npm ERR! Did you mean one of these?
npm ERR! npm run doc
npm ERR! npm run doc:show
npm ERR!
npm ERR! To see a list of scripts, run:
npm ERR! npm run
Question : Specifying the plugin installation from the `pyproject.toml` file
pyproject.toml file?poetry install
poetry run test
Releases(0.3.5)
0.3.5(Aug 26, 2022)
What's Changed
Source code(zip)
0.3.4(Jul 6, 2022)
What's Changed
New Contributors
Source code(zip)
0.3.3(Jun 25, 2022)
What's Changed
New Contributors
Source code(zip)
0.3.2(Oct 18, 2021)
What's Changed
New Contributors
Source code(zip)
0.3.1(Sep 12, 2021)
0.3.0(Sep 12, 2021)
Source code(zip)
0.2.1(Aug 21, 2021)
Source code(zip)
0.2.0(Aug 21, 2021)
0.1.0(Aug 21, 2021)
Source code(zip)
31 Jul 13, 2022
9 Dec 02, 2022
113 Jan 03, 2023
2.3k Dec 28, 2022
3 Jun 07, 2022
2 Mar 07, 2022
3 Jan 11, 2022
1.7k Jan 04, 2023
8 Apr 04, 2022
419 Jan 01, 2023
1 Apr 08, 2022
1 Jan 07, 2022
3 Sep 20, 2021
8 Nov 04, 2022
889 Jan 01, 2023
3.6k Dec 29, 2022
4 May 07, 2022
2 Jan 10, 2022
2 May 28, 2021
8 Dec 14, 2022