# poetry-aliases
[](https://pypi.org/project/poetry-aliases)
[](https://pypi.org/project/poetry-aliases)
[](https://github.com/celsiusnarhwal/poetry-aliases/releases)
[](https://github.com/celsiusnarhwal/poetry-aliases/blob/main/LICENSE)
[](https://github.com/psf/black)
poetry-aliases is a [Poetry](https://python-poetry.org/) plugin that enables the creation of aliases for Poetry
commands.
## Installation
```bash
poetry self add poetry-aliases
```
## Usage
First, add aliases via `poetry aliases`.
```bash
poetry aliases
```
`poetry aliases` will open a file in `$EDITOR` where you can view, add, and edit your aliases.
```toml
# Write each alias on a separate line, e.g.:
# i = "install"
# r = "remove"
# dev = "add --group dev"
# plugins = "self show plugins"
# Aliases that are not strings or conflict with other Poetry commands will be ignored.
# Save this file and close the editor when you're done.
i = "install"
r = "remove"
dev = "add --group dev"
plugins = "self show plugins"
```
Your aliases will be saved to Poetry's `config.toml` file.
Once your aliases have been saved, you can use them like any other Poetry command.
```bash
poetry i
# Installing dependencies from lock file
poetry r yapf
# Package operations: 0 installs, 0 updates, 1 removal
# • Removing yapf (0.32.0)
poetry dev black
# Package operations: 3 installs, 0 updates, 0 removals
# • Installing mypy-extensions (0.4.3)
# • Installing pathspec (0.11.0)
# • Installing black (23.1.0)
poetry plugins
# • poetry-aliases (1.0.0) Create aliases for Poetry commands
# 1 application plugin
#
# Dependencies
# - click (>=8.1.3,<9.0.0)
# - poetry (>=1.3.2,<2.0.0)
```
## License
poetry-aliases is licensed under the [MIT License](LICENSE.md).
Raw data
{
"_id": null,
"home_page": "https://github.com/celsiusnarhwal/poetry-aliases",
"name": "poetry-aliases",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "celsius narhwal",
"author_email": "hello@celsiusnarhwal.dev",
"download_url": "https://files.pythonhosted.org/packages/0c/c6/3bb1afa16b7926c6746c64df8904021d6bf581e9a3c4a45aec0fc1ba1e38/poetry_aliases-1.0.1.tar.gz",
"platform": null,
"description": "# poetry-aliases\n\n[](https://pypi.org/project/poetry-aliases)\n[](https://pypi.org/project/poetry-aliases)\n[](https://github.com/celsiusnarhwal/poetry-aliases/releases)\n[](https://github.com/celsiusnarhwal/poetry-aliases/blob/main/LICENSE)\n[](https://github.com/psf/black)\n\npoetry-aliases is a [Poetry](https://python-poetry.org/) plugin that enables the creation of aliases for Poetry \ncommands.\n\n## Installation\n\n```bash\npoetry self add poetry-aliases\n```\n\n## Usage\n\nFirst, add aliases via `poetry aliases`.\n\n```bash\npoetry aliases\n```\n\n`poetry aliases` will open a file in `$EDITOR` where you can view, add, and edit your aliases.\n\n```toml\n# Write each alias on a separate line, e.g.:\n\n# i = \"install\"\n# r = \"remove\"\n# dev = \"add --group dev\"\n# plugins = \"self show plugins\"\n\n# Aliases that are not strings or conflict with other Poetry commands will be ignored.\n\n# Save this file and close the editor when you're done.\n\ni = \"install\"\nr = \"remove\"\ndev = \"add --group dev\"\nplugins = \"self show plugins\"\n```\n\nYour aliases will be saved to Poetry's `config.toml` file.\n\nOnce your aliases have been saved, you can use them like any other Poetry command.\n\n```bash\npoetry i\n\n# Installing dependencies from lock file\n\npoetry r yapf\n\n# Package operations: 0 installs, 0 updates, 1 removal\n\n# \u2022 Removing yapf (0.32.0)\n\n\npoetry dev black\n\n# Package operations: 3 installs, 0 updates, 0 removals\n\n# \u2022 Installing mypy-extensions (0.4.3)\n# \u2022 Installing pathspec (0.11.0)\n# \u2022 Installing black (23.1.0)\n\n\npoetry plugins\n\n# \u2022 poetry-aliases (1.0.0) Create aliases for Poetry commands\n# 1 application plugin\n#\n# Dependencies\n# - click (>=8.1.3,<9.0.0)\n# - poetry (>=1.3.2,<2.0.0)\n```\n\n## License\n\npoetry-aliases is licensed under the [MIT License](LICENSE.md).",
"bugtrack_url": null,
"license": "",
"summary": "Create aliases for Poetry commands",
"version": "1.0.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c7684f3e31744c7af39d2d286ee39ef97ff5138a62aa117b55b26b56e3006a00",
"md5": "0093841aad1261f089b928d5dbb5b6f0",
"sha256": "8d1958934190bc8d9a0b11970612bc8904e1308e9b25e960f36a7d1173431ade"
},
"downloads": -1,
"filename": "poetry_aliases-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0093841aad1261f089b928d5dbb5b6f0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 4782,
"upload_time": "2023-02-03T02:02:19",
"upload_time_iso_8601": "2023-02-03T02:02:19.370468Z",
"url": "https://files.pythonhosted.org/packages/c7/68/4f3e31744c7af39d2d286ee39ef97ff5138a62aa117b55b26b56e3006a00/poetry_aliases-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0cc63bb1afa16b7926c6746c64df8904021d6bf581e9a3c4a45aec0fc1ba1e38",
"md5": "037dd8bd125637f735d7e9ff87e7a3a4",
"sha256": "15652fcdf2b4a8e55b16bf4e86f1c1975090b8198edc7b87770418fbffb0c488"
},
"downloads": -1,
"filename": "poetry_aliases-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "037dd8bd125637f735d7e9ff87e7a3a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 3925,
"upload_time": "2023-02-03T02:02:20",
"upload_time_iso_8601": "2023-02-03T02:02:20.598543Z",
"url": "https://files.pythonhosted.org/packages/0c/c6/3bb1afa16b7926c6746c64df8904021d6bf581e9a3c4a45aec0fc1ba1e38/poetry_aliases-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-03 02:02:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "celsiusnarhwal",
"github_project": "poetry-aliases",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "poetry-aliases"
}
JSON
