| Name | poetry-pipx JSON |
| Version |
0.0.0
JSON |
| download |
| home_page | https://github.com/bswck/poetry-pipx |
| Summary | A Poetry plugin that allows pipx to take precedence when installing CLI dependencies. |
| upload_time | 2023-12-04 02:12:53 |
| maintainer | |
| docs_url | None |
| author | bswck |
| requires_python | >=3.8,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# poetry-pipx [](https://pypi.org/project/poetry-pipx/) [](https://pypi.org/project/poetry-pipx/)
[](https://github.com/bswck/poetry-pipx/actions/workflows/test.yml)
[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/poetry-pipx)
[](https://python-poetry.org/)
[](https://github.com/astral-sh/ruff)
[](https://github.com/psf/black)
[](https://github.com/bswck/poetry-pipx/blob/HEAD/LICENSE)
[](https://github.com/pre-commit/pre-commit)
A [Poetry](https://python-poetry.org/) plugin that allows [pipx](https://github.com/pypa/pipx#readme) to take precedence when installing CLI dependencies.
# Installation
If you want to…
## …use this tool in your project 💻
```shell
poetry self add poetry-pipx
```
## …contribute to [poetry-pipx](https://github.com/bswck/poetry-pipx) 🚀
> [!Note]
> If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).
1. Fork the [poetry-pipx repository](https://github.com/bswck/poetry-pipx) on GitHub.
1. [Install Poetry](https://python-poetry.org/docs/#installation).<br/>
Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.
You might use [pipx](https://github.com/pypa/pipx#readme) to install it globally (recommended):
```shell
pipx install poetry
```
<sub>If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.</sub>
If you want to use pipx to install dev dependencies as well, install the [export plugin](https://github.com/python-poetry/poetry-plugin-export#readme):
```shell
pipx inject poetry poetry-plugin-export poetry-pipx
```
Be sure to have Python 3.8 installed—if you use [pyenv](https://github.com/pyenv/pyenv#readme), simply run:
```shell
pyenv install 3.8
```
1. Clone your fork locally and install dependencies.
```shell
git clone https://github.com/your-username/poetry-pipx path/to/poetry-pipx
cd path/to/poetry-pipx
poetry env use $(cat .python-version)
```
If you use pipx, run the following command to install dev dependencies globally:
```shell
poetry install --without=dev
poetry pipx install dev
```
Otherwise, run:
```shell
poetry install
```
Next up, simply activate the virtual environment and install pre-commit hooks:
```shell
poetry shell
pre-commit install --hook-type pre-commit --hook-type pre-push
```
For more information on how to contribute, check out [CONTRIBUTING.md](https://github.com/bswck/poetry-pipx/blob/HEAD/CONTRIBUTING.md).<br/>
Always happy to accept contributions! ❤️
# Legal info
© Copyright by Bartosz Sławecki ([@bswck](https://github.com/bswck)).
<br />This software is licensed under the terms of [MIT License](https://github.com/bswck/poetry-pipx/blob/HEAD/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/bswck/poetry-pipx",
"name": "poetry-pipx",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "bswck",
"author_email": "bswck.dev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/02/98/014908b85d008abeeefa4dca968c1a1534a91d5572dc7f51bcc95d15e295/poetry_pipx-0.0.0.tar.gz",
"platform": null,
"description": "\n# poetry-pipx [](https://pypi.org/project/poetry-pipx/) [](https://pypi.org/project/poetry-pipx/)\n[](https://github.com/bswck/poetry-pipx/actions/workflows/test.yml)\n[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/poetry-pipx)\n[](https://python-poetry.org/)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/psf/black)\n[](https://github.com/bswck/poetry-pipx/blob/HEAD/LICENSE)\n[](https://github.com/pre-commit/pre-commit)\n\nA [Poetry](https://python-poetry.org/) plugin that allows [pipx](https://github.com/pypa/pipx#readme) to take precedence when installing CLI dependencies.\n\n# Installation\nIf you want to\u2026\n\n\n\n## \u2026use this tool in your project \ud83d\udcbb\n```shell\npoetry self add poetry-pipx\n```\n\n## \u2026contribute to [poetry-pipx](https://github.com/bswck/poetry-pipx) \ud83d\ude80\n\n\n> [!Note]\n> If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).\n\n\n\n1. Fork the [poetry-pipx repository](https://github.com/bswck/poetry-pipx) on GitHub.\n\n1. [Install Poetry](https://python-poetry.org/docs/#installation).<br/>\n Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.\n You might use [pipx](https://github.com/pypa/pipx#readme) to install it globally (recommended):\n\n ```shell\n pipx install poetry\n ```\n\n <sub>If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.</sub>\n\n If you want to use pipx to install dev dependencies as well, install the [export plugin](https://github.com/python-poetry/poetry-plugin-export#readme):\n ```shell\n pipx inject poetry poetry-plugin-export poetry-pipx\n ```\n\n Be sure to have Python 3.8 installed\u2014if you use [pyenv](https://github.com/pyenv/pyenv#readme), simply run:\n\n ```shell\n pyenv install 3.8\n ```\n\n1. Clone your fork locally and install dependencies.\n\n ```shell\n git clone https://github.com/your-username/poetry-pipx path/to/poetry-pipx\n cd path/to/poetry-pipx\n poetry env use $(cat .python-version)\n ```\n\n If you use pipx, run the following command to install dev dependencies globally:\n ```shell\n poetry install --without=dev\n poetry pipx install dev\n ```\n Otherwise, run:\n\n ```shell\n poetry install\n ```\n Next up, simply activate the virtual environment and install pre-commit hooks:\n\n ```shell\n poetry shell\n pre-commit install --hook-type pre-commit --hook-type pre-push\n ```\n\nFor more information on how to contribute, check out [CONTRIBUTING.md](https://github.com/bswck/poetry-pipx/blob/HEAD/CONTRIBUTING.md).<br/>\nAlways happy to accept contributions! \u2764\ufe0f\n\n\n# Legal info\n\u00a9 Copyright by Bartosz S\u0142awecki ([@bswck](https://github.com/bswck)).\n<br />This software is licensed under the terms of [MIT License](https://github.com/bswck/poetry-pipx/blob/HEAD/LICENSE).\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Poetry plugin that allows pipx to take precedence when installing CLI dependencies.",
"version": "0.0.0",
"project_urls": {
"Coverage": "https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/poetry-pipx",
"Distribution": "https://pypi.org/project/poetry-pipx/",
"Documentation": "https://poetry-pipx.readthedocs.io/en/latest/",
"Homepage": "https://github.com/bswck/poetry-pipx",
"Issues": "https://github.com/bswck/poetry-pipx/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "57fb12df783832fcf3fab10c114da18b8ded0ce3a4705835a5bd240c042b0d7a",
"md5": "995008ee657d0d01e11fa86b969cd48c",
"sha256": "9c89e1c3f8ffdf53581fc2a0d0f53e84faa486314bacac8af48ff7ba2961e8c0"
},
"downloads": -1,
"filename": "poetry_pipx-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "995008ee657d0d01e11fa86b969cd48c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 3738,
"upload_time": "2023-12-04T02:12:51",
"upload_time_iso_8601": "2023-12-04T02:12:51.505662Z",
"url": "https://files.pythonhosted.org/packages/57/fb/12df783832fcf3fab10c114da18b8ded0ce3a4705835a5bd240c042b0d7a/poetry_pipx-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0298014908b85d008abeeefa4dca968c1a1534a91d5572dc7f51bcc95d15e295",
"md5": "e7bf452c4c2d70e923741f7496166c84",
"sha256": "7df43cfc29eb74a78bc60de2d03b8462a24a0e4b8cc94c30e854f97325d979ea"
},
"downloads": -1,
"filename": "poetry_pipx-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e7bf452c4c2d70e923741f7496166c84",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 4100,
"upload_time": "2023-12-04T02:12:53",
"upload_time_iso_8601": "2023-12-04T02:12:53.000942Z",
"url": "https://files.pythonhosted.org/packages/02/98/014908b85d008abeeefa4dca968c1a1534a91d5572dc7f51bcc95d15e295/poetry_pipx-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-04 02:12:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bswck",
"github_project": "poetry-pipx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "poetry-pipx"
}
