| Name | poetry-plugin-commands JSON |
| Version |
0.0.9
JSON |
| download |
| home_page | None |
| Summary | Poetry plugin for simple custom user commands execution. |
| upload_time | 2024-04-27 13:19:55 |
| maintainer | None |
| docs_url | None |
| author | BlackCatDevel0per |
| requires_python | <4.0,>=3.8 |
| license | Apache 2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## Poetry Command Aliases Plugin
This plugin allows you to define aliases or shortcuts for commonly used commands in your Poetry projects. It simplifies command execution by providing custom aliases for complex or frequently used commands.
### Usage
1. **Installation**:
Install the plugin using Poetry:
```bash
pip install poetry-plugin-commands
```
or
```bash
pip install --user poetry-plugin-commands
```
or at least
```bash
poetry self add poetry-plugin-commands
```
2. **Define Aliases**:
Add your aliases to the `pyproject.toml` file under the `[tool.poetry-plugin-commands]` section:
```toml
[tool.poetry-plugin-commands]
stree = "tree src"
test_var = "echo $VAR"
run_app = "PYTHONPATH=src:. poetry run python src/app_launch/main.py"
```
Here, `stree`, `test_var`, and `run_app` are the custom aliases, and their corresponding commands are specified.
3. **Execute Commands**:
Now you can use the defined aliases with Poetry:
```bash
poetry stree
```
```bash
poetry test_var
```
```bash
poetry run_app
```
These commands will execute the respective commands defined as aliases.
4. **List Available Commands**:
To get a list of available aliases along with their corresponding commands, run:
```bash
poetry user-commands
```
This will display a list of aliases and their associated commands:
```plaintext
stree -> `tree src`
test_var -> `echo $VAR`
run_app -> `PYTHONPATH=src:. poetry run python src/app_launch/main.py`
```
### Contributing
Feel free to contribute to this plugin by reporting issues, suggesting features, or submitting pull requests on [GitHub](https://github.com/BlackCatDevel0per/poetry-plugin-commands).
### License
This plugin is licensed under the Apache 2. License. See the [LICENSE](https://www.apache.org/licenses/LICENSE-2.0) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "poetry-plugin-commands",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "BlackCatDevel0per",
"author_email": "bcdev@mail.ru",
"download_url": "https://files.pythonhosted.org/packages/3d/6e/e1cc71c843919f5942d461ac3a511afac782f1ca2677e66f522b20981f4d/poetry_plugin_commands-0.0.9.tar.gz",
"platform": null,
"description": "## Poetry Command Aliases Plugin\n\nThis plugin allows you to define aliases or shortcuts for commonly used commands in your Poetry projects. It simplifies command execution by providing custom aliases for complex or frequently used commands.\n\n### Usage\n\n1. **Installation**:\n\n Install the plugin using Poetry:\n\n ```bash\n pip install poetry-plugin-commands\n ```\n\n or\n\n ```bash\n pip install --user poetry-plugin-commands\n ```\n\n or at least\n\n ```bash\n poetry self add poetry-plugin-commands\n ```\n\n2. **Define Aliases**:\n\n Add your aliases to the `pyproject.toml` file under the `[tool.poetry-plugin-commands]` section:\n\n ```toml\n [tool.poetry-plugin-commands]\n stree = \"tree src\"\n test_var = \"echo $VAR\"\n run_app = \"PYTHONPATH=src:. poetry run python src/app_launch/main.py\"\n ```\n\n Here, `stree`, `test_var`, and `run_app` are the custom aliases, and their corresponding commands are specified.\n\n3. **Execute Commands**:\n\n Now you can use the defined aliases with Poetry:\n\n ```bash\n poetry stree\n ```\n\n ```bash\n poetry test_var\n ```\n\n ```bash\n poetry run_app\n ```\n\n These commands will execute the respective commands defined as aliases.\n\n4. **List Available Commands**:\n\n To get a list of available aliases along with their corresponding commands, run:\n\n ```bash\n poetry user-commands\n ```\n\n This will display a list of aliases and their associated commands:\n\n ```plaintext\n stree -> `tree src`\n test_var -> `echo $VAR`\n run_app -> `PYTHONPATH=src:. poetry run python src/app_launch/main.py`\n ```\n\n### Contributing\n\nFeel free to contribute to this plugin by reporting issues, suggesting features, or submitting pull requests on [GitHub](https://github.com/BlackCatDevel0per/poetry-plugin-commands).\n\n### License\n\nThis plugin is licensed under the Apache 2. License. See the [LICENSE](https://www.apache.org/licenses/LICENSE-2.0) file for details.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Poetry plugin for simple custom user commands execution.",
"version": "0.0.9",
"project_urls": {
"Documentation": "https://github.com/BlackCatDevel0per/poetry-plugin-commands",
"Homepage": "https://github.com/BlackCatDevel0per/poetry-plugin-commands",
"Repository": "https://github.com/BlackCatDevel0per/poetry-plugin-commands"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "755c497454d599c102486e8d30771514c7d1bcdb74f7d8d81b198b9649569906",
"md5": "65f3b656fb116940ec5674316e13c314",
"sha256": "7aa015785b2536552407fbaf325c4edd1334ccc04cfda73e355b9b9c56a671ff"
},
"downloads": -1,
"filename": "poetry_plugin_commands-0.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "65f3b656fb116940ec5674316e13c314",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 8447,
"upload_time": "2024-04-27T13:19:54",
"upload_time_iso_8601": "2024-04-27T13:19:54.641948Z",
"url": "https://files.pythonhosted.org/packages/75/5c/497454d599c102486e8d30771514c7d1bcdb74f7d8d81b198b9649569906/poetry_plugin_commands-0.0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3d6ee1cc71c843919f5942d461ac3a511afac782f1ca2677e66f522b20981f4d",
"md5": "005526ee3fae85d9862154b26a766dd9",
"sha256": "c4ceccf3a3c005ae670f3465d2b8f5490ea3998472a0400e55201e821db8e505"
},
"downloads": -1,
"filename": "poetry_plugin_commands-0.0.9.tar.gz",
"has_sig": false,
"md5_digest": "005526ee3fae85d9862154b26a766dd9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 7734,
"upload_time": "2024-04-27T13:19:55",
"upload_time_iso_8601": "2024-04-27T13:19:55.819768Z",
"url": "https://files.pythonhosted.org/packages/3d/6e/e1cc71c843919f5942d461ac3a511afac782f1ca2677e66f522b20981f4d/poetry_plugin_commands-0.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-27 13:19:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BlackCatDevel0per",
"github_project": "poetry-plugin-commands",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "poetry-plugin-commands"
}
