| Name | poetry-plugin-export-packages JSON |
| Version |
1.0.3
JSON |
| download |
| home_page | |
| Summary | Poetry plugin to export project dependencies as separate pip packages. |
| upload_time | 2024-02-13 10:07:50 |
| maintainer | |
| docs_url | None |
| author | Ilya O. |
| requires_python | >=3.8,<4 |
| license | MIT |
| keywords |
poetry
plugin
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Poetry Package Exporter Plugin
## Introduction
The Poetry Package Exporter is a plugin for the [poetry](https://python-poetry.org/) package manager. It is designed to enhance the CI process by exporting project dependencies as separate pip-installable packages. By doing so, it allows you to leverage the existing Poetry cache, resulting in significantly shorter optimized build times.
## Features
- **Dependency Exportation**: Automatically exports your Poetry-managed dependencies into pip-installable packages.
- **Cache Re-utilization**: Leverages Poetry's cache system to avoid redundant downloads, speeding up the Docker build process.
## Installation
To install the Poetry Package Exporter plugin, run the following command in your terminal:
```sh
poetry plugin add poetry_plugin_export_packages
```
or
```sh
pip install poetry_plugin_export_packages
```
Ensure you have Poetry installed prior to adding this plugin. For instructions on installing Poetry, visit [Poetry's documentation](https://python-poetry.org/docs/).
## Usage
After installing the plugin, use the following command to export your dependencies:
```sh
poetry export-packages
```
This command will generate a set of pip-installable packages for your project's dependencies. You can then copy these packages into your Docker build context and use pip to install them during the Docker image build process.
## Configuration
The plugin supports several configuration options to customize the export process.
```sh
$ poetry export-packages -h
Description:
export python packages
Usage:
export-packages [options]
Options:
-o, --output-dir=OUTPUT-DIR Directory to save packages to. [default: "export-packages"]
--shebang=SHEBANG Shebang to start the generated pip install script with [default: "#! /bin/sh"]
-f, --output-script[=OUTPUT-SCRIPT] Place to save output script to.
--without=WITHOUT The dependency groups to ignore. (multiple values allowed)
--with=WITH The optional dependency groups to include. (multiple values allowed)
--only=ONLY The only dependency groups to include. (multiple values allowed)
-h, --help Display help for the given command. When no command is given display help for the list command.
-q, --quiet Do not output any message.
-V, --version Display this application version.
--ansi Force ANSI output.
--no-ansi Disable ANSI output.
-n, --no-interaction Do not ask any interactive question.
--no-plugins Disables plugins.
--no-cache Disables Poetry source caches.
-C, --directory=DIRECTORY The working directory for the Poetry command (defaults to the current working directory).
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.
```
## Contributing
Contributions to the Poetry Dependency Exporter are welcome!
## License
This project is licensed under the [MIT License](LICENSE). See the LICENSE file for more details.
Raw data
{
"_id": null,
"home_page": "",
"name": "poetry-plugin-export-packages",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4",
"maintainer_email": "",
"keywords": "poetry,plugin",
"author": "Ilya O.",
"author_email": "vrghost@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/bf/55/9a1f3f7be9c9628b2ccadb25cca7b4df49026c5d433595b58a9cb109c687/poetry_plugin_export_packages-1.0.3.tar.gz",
"platform": null,
"description": "# Poetry Package Exporter Plugin\n\n## Introduction\n\nThe Poetry Package Exporter is a plugin for the [poetry](https://python-poetry.org/) package manager. It is designed to enhance the CI process by exporting project dependencies as separate pip-installable packages. By doing so, it allows you to leverage the existing Poetry cache, resulting in significantly shorter optimized build times.\n\n## Features\n\n- **Dependency Exportation**: Automatically exports your Poetry-managed dependencies into pip-installable packages.\n- **Cache Re-utilization**: Leverages Poetry's cache system to avoid redundant downloads, speeding up the Docker build process.\n\n## Installation\n\nTo install the Poetry Package Exporter plugin, run the following command in your terminal:\n\n```sh\npoetry plugin add poetry_plugin_export_packages\n```\n\nor\n\n```sh\npip install poetry_plugin_export_packages\n```\n\nEnsure you have Poetry installed prior to adding this plugin. For instructions on installing Poetry, visit [Poetry's documentation](https://python-poetry.org/docs/).\n\n## Usage\n\nAfter installing the plugin, use the following command to export your dependencies:\n\n```sh\npoetry export-packages\n```\n\nThis command will generate a set of pip-installable packages for your project's dependencies. You can then copy these packages into your Docker build context and use pip to install them during the Docker image build process.\n\n## Configuration\n\nThe plugin supports several configuration options to customize the export process. \n\n```sh\n$ poetry export-packages -h\n\nDescription:\n export python packages\n\nUsage:\n export-packages [options]\n\nOptions:\n -o, --output-dir=OUTPUT-DIR Directory to save packages to. [default: \"export-packages\"]\n --shebang=SHEBANG Shebang to start the generated pip install script with [default: \"#! /bin/sh\"]\n -f, --output-script[=OUTPUT-SCRIPT] Place to save output script to.\n --without=WITHOUT The dependency groups to ignore. (multiple values allowed)\n --with=WITH The optional dependency groups to include. (multiple values allowed)\n --only=ONLY The only dependency groups to include. (multiple values allowed)\n -h, --help Display help for the given command. When no command is given display help for the list command.\n -q, --quiet Do not output any message.\n -V, --version Display this application version.\n --ansi Force ANSI output.\n --no-ansi Disable ANSI output.\n -n, --no-interaction Do not ask any interactive question.\n --no-plugins Disables plugins.\n --no-cache Disables Poetry source caches.\n -C, --directory=DIRECTORY The working directory for the Poetry command (defaults to the current working directory).\n -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.\n\n```\n\n\n## Contributing\n\nContributions to the Poetry Dependency Exporter are welcome! \n\n## License\n\nThis project is licensed under the [MIT License](LICENSE). See the LICENSE file for more details.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Poetry plugin to export project dependencies as separate pip packages.",
"version": "1.0.3",
"project_urls": {
"Source": "https://github.com/VRGhost/poetry-plugin-export-packages"
},
"split_keywords": [
"poetry",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "134adfc48cdd90484f5942d391937568452a896aa4ec55e56bc36cb21f719b7c",
"md5": "6c49a7f261857e0c727cc002181ed3ee",
"sha256": "ce548529456a08eed90ed8d2d55a941899b7ac277a81bc4096205ecd9fb68eca"
},
"downloads": -1,
"filename": "poetry_plugin_export_packages-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6c49a7f261857e0c727cc002181ed3ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4",
"size": 7163,
"upload_time": "2024-02-13T10:07:49",
"upload_time_iso_8601": "2024-02-13T10:07:49.217677Z",
"url": "https://files.pythonhosted.org/packages/13/4a/dfc48cdd90484f5942d391937568452a896aa4ec55e56bc36cb21f719b7c/poetry_plugin_export_packages-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf559a1f3f7be9c9628b2ccadb25cca7b4df49026c5d433595b58a9cb109c687",
"md5": "0c7648c549eb3de0886384b833d17020",
"sha256": "1f4ee308a12d2cfc50a6aeeeb1ab9040e246e54f99f0dad3488cd9f8ff7970d9"
},
"downloads": -1,
"filename": "poetry_plugin_export_packages-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "0c7648c549eb3de0886384b833d17020",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4",
"size": 6144,
"upload_time": "2024-02-13T10:07:50",
"upload_time_iso_8601": "2024-02-13T10:07:50.748699Z",
"url": "https://files.pythonhosted.org/packages/bf/55/9a1f3f7be9c9628b2ccadb25cca7b4df49026c5d433595b58a9cb109c687/poetry_plugin_export_packages-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-13 10:07:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VRGhost",
"github_project": "poetry-plugin-export-packages",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "poetry-plugin-export-packages"
}
