| Name | poetry-plugin-bundle JSON |
| Version |
1.4.1
JSON |
| download |
| home_page | None |
| Summary | Poetry plugin to bundle projects into various formats |
| upload_time | 2024-08-15 20:17:52 |
| maintainer | None |
| docs_url | None |
| author | Sébastien Eustace |
| requires_python | <4.0,>=3.8 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Poetry Plugin: Bundle
[](https://python-poetry.org/)
This package is a plugin that allows the bundling of Poetry projects into various formats.
## Installation
The easiest way to install the `bundle` plugin is via the `self add` command of Poetry.
```bash
poetry self add poetry-plugin-bundle
```
If you used `pipx` to install Poetry you can add the plugin via the `pipx inject` command.
```bash
pipx inject poetry poetry-plugin-bundle
```
Otherwise, if you used `pip` to install Poetry you can add the plugin packages via the `pip install` command.
```bash
pip install poetry-plugin-bundle
```
## Usage
The plugin introduces a `bundle` command namespace that regroups commands to bundle the current project
and its dependencies into various formats. These commands are particularly useful to deploy
Poetry-managed applications.
### bundle venv
### bundle venv
The `bundle venv` command bundles the project and its dependencies into a virtual environment.
The following command
```bash
poetry bundle venv /path/to/environment
```
will bundle the project in the `/path/to/environment` directory by creating the virtual environment,
installing the dependencies and the current project inside it. If the directory does not exist,
it will be created automatically.
By default, the command uses the same Python executable that Poetry would use
when running `poetry install` to build the virtual environment.
If you want to use a different one, you can specify it with the `--python/-p` option:
```bash
poetry bundle venv /path/to/environment --python /full/path/to/python
poetry bundle venv /path/to/environment -p python3.8
poetry bundle venv /path/to/environment -p 3.8
```
**Note**
If the virtual environment already exists, two things can happen:
- **The python version of the virtual environment is the same as the main one**: the dependencies will be synced (updated or removed).
- **The python version of the virtual environment is different**: the virtual environment will be recreated from scratch.
You can also ensure that the virtual environment is recreated by using the `--clear` option:
```bash
poetry bundle venv /path/to/environment --clear
```
Raw data
{
"_id": null,
"home_page": null,
"name": "poetry-plugin-bundle",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "S\u00e9bastien Eustace",
"author_email": "sebastien@eustace.io",
"download_url": "https://files.pythonhosted.org/packages/bf/cf/b78667a102e3ed8325ae48e0b4ffe00afafc59128ae623ea6856484adf1d/poetry_plugin_bundle-1.4.1.tar.gz",
"platform": null,
"description": "# Poetry Plugin: Bundle\n\n[](https://python-poetry.org/)\n\nThis package is a plugin that allows the bundling of Poetry projects into various formats.\n\n## Installation\n\nThe easiest way to install the `bundle` plugin is via the `self add` command of Poetry.\n\n```bash\npoetry self add poetry-plugin-bundle\n```\n\nIf you used `pipx` to install Poetry you can add the plugin via the `pipx inject` command.\n\n```bash\npipx inject poetry poetry-plugin-bundle\n```\n\nOtherwise, if you used `pip` to install Poetry you can add the plugin packages via the `pip install` command.\n\n```bash\npip install poetry-plugin-bundle\n```\n\n## Usage\n\nThe plugin introduces a `bundle` command namespace that regroups commands to bundle the current project\nand its dependencies into various formats. These commands are particularly useful to deploy\nPoetry-managed applications.\n\n### bundle venv\n\n### bundle venv\n\nThe `bundle venv` command bundles the project and its dependencies into a virtual environment.\n\nThe following command\n\n```bash\npoetry bundle venv /path/to/environment\n```\n\nwill bundle the project in the `/path/to/environment` directory by creating the virtual environment,\ninstalling the dependencies and the current project inside it. If the directory does not exist,\nit will be created automatically.\n\nBy default, the command uses the same Python executable that Poetry would use\nwhen running `poetry install` to build the virtual environment.\nIf you want to use a different one, you can specify it with the `--python/-p` option:\n\n```bash\npoetry bundle venv /path/to/environment --python /full/path/to/python\npoetry bundle venv /path/to/environment -p python3.8\npoetry bundle venv /path/to/environment -p 3.8\n```\n\n**Note**\n\nIf the virtual environment already exists, two things can happen:\n\n- **The python version of the virtual environment is the same as the main one**: the dependencies will be synced (updated or removed).\n- **The python version of the virtual environment is different**: the virtual environment will be recreated from scratch.\n\nYou can also ensure that the virtual environment is recreated by using the `--clear` option:\n\n```bash\npoetry bundle venv /path/to/environment --clear\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Poetry plugin to bundle projects into various formats",
"version": "1.4.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "21c35a9de4758867f6382c87cc40e7f054867cc7e6443e73a9fa20880e25f2f9",
"md5": "f9e3c40065b715a541ff45c696b36634",
"sha256": "4b1908504a73fa238fa8c2506df387e7b2dc3bf52a512907fe3d4ee32d66bdf1"
},
"downloads": -1,
"filename": "poetry_plugin_bundle-1.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f9e3c40065b715a541ff45c696b36634",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 8996,
"upload_time": "2024-08-15T20:17:51",
"upload_time_iso_8601": "2024-08-15T20:17:51.378780Z",
"url": "https://files.pythonhosted.org/packages/21/c3/5a9de4758867f6382c87cc40e7f054867cc7e6443e73a9fa20880e25f2f9/poetry_plugin_bundle-1.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bfcfb78667a102e3ed8325ae48e0b4ffe00afafc59128ae623ea6856484adf1d",
"md5": "a14df04df000fb68ed0251d48f9441ff",
"sha256": "9f9da8289157d88e8ecb918fd8c342e9a7053d9bc2468cfb461a16e4ec439e84"
},
"downloads": -1,
"filename": "poetry_plugin_bundle-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "a14df04df000fb68ed0251d48f9441ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 12399,
"upload_time": "2024-08-15T20:17:52",
"upload_time_iso_8601": "2024-08-15T20:17:52.666219Z",
"url": "https://files.pythonhosted.org/packages/bf/cf/b78667a102e3ed8325ae48e0b4ffe00afafc59128ae623ea6856484adf1d/poetry_plugin_bundle-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-15 20:17:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "poetry-plugin-bundle"
}
