poetry-plugin-export


Namepoetry-plugin-export JSON
Version 1.8.0 PyPI version JSON
download
home_pagehttps://python-poetry.org/
SummaryPoetry plugin to export the dependencies to various formats
upload_time2024-05-11 16:11:35
maintainerNone
docs_urlNone
authorSébastien Eustace
requires_python<4.0,>=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Poetry Plugin: Export

[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)

This package is a plugin that allows the export of locked packages to various formats.

**Note**: For now, only the `constraints.txt` and `requirements.txt` formats are available.

This plugin provides the same features as the existing `export` command of Poetry which it will eventually replace.


## Installation

The easiest way to install the `export` plugin is via the `self add` command of Poetry.

```bash
poetry self add poetry-plugin-export
```

If you used `pipx` to install Poetry you can add the plugin via the `pipx inject` command.

```bash
pipx inject poetry poetry-plugin-export
```

Otherwise, if you used `pip` to install Poetry you can add the plugin packages via the `pip install` command.

```bash
pip install poetry-plugin-export
```


## Usage

The plugin provides an `export` command to export to the desired format.

```bash
poetry export -f requirements.txt --output requirements.txt
```

**Note**: Only the `constraints.txt` and `requirements.txt` formats are currently supported.

### Available options

* `--format (-f)`: The format to export to (default: `requirements.txt`). Currently, only `constraints.txt` and `requirements.txt` are supported.
* `--output (-o)`: The name of the output file.  If omitted, print to standard output.
* `--without`: The dependency groups to ignore when exporting.
* `--with`: The optional dependency groups to include when exporting.
* `--only`: The only dependency groups to include when exporting.
* `--default`: Only export the main dependencies. (**Deprecated**)
* `--dev`: Include development dependencies. (**Deprecated**)
* `--extras (-E)`: Extra sets of dependencies to include.
* `--all-extras`: Include all sets of extra dependencies.
* `--without-hashes`: Exclude hashes from the exported file.
* `--with-credentials`: Include credentials for extra indices.

Raw data

            {
    "_id": null,
    "home_page": "https://python-poetry.org/",
    "name": "poetry-plugin-export",
    "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/81/bf/270ef984c6f4b610a22a6948096b6b9d949de8f77c4c427d981c530ac521/poetry_plugin_export-1.8.0.tar.gz",
    "platform": null,
    "description": "# Poetry Plugin: Export\n\n[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)\n\nThis package is a plugin that allows the export of locked packages to various formats.\n\n**Note**: For now, only the `constraints.txt` and `requirements.txt` formats are available.\n\nThis plugin provides the same features as the existing `export` command of Poetry which it will eventually replace.\n\n\n## Installation\n\nThe easiest way to install the `export` plugin is via the `self add` command of Poetry.\n\n```bash\npoetry self add poetry-plugin-export\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-export\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-export\n```\n\n\n## Usage\n\nThe plugin provides an `export` command to export to the desired format.\n\n```bash\npoetry export -f requirements.txt --output requirements.txt\n```\n\n**Note**: Only the `constraints.txt` and `requirements.txt` formats are currently supported.\n\n### Available options\n\n* `--format (-f)`: The format to export to (default: `requirements.txt`). Currently, only `constraints.txt` and `requirements.txt` are supported.\n* `--output (-o)`: The name of the output file.  If omitted, print to standard output.\n* `--without`: The dependency groups to ignore when exporting.\n* `--with`: The optional dependency groups to include when exporting.\n* `--only`: The only dependency groups to include when exporting.\n* `--default`: Only export the main dependencies. (**Deprecated**)\n* `--dev`: Include development dependencies. (**Deprecated**)\n* `--extras (-E)`: Extra sets of dependencies to include.\n* `--all-extras`: Include all sets of extra dependencies.\n* `--without-hashes`: Exclude hashes from the exported file.\n* `--with-credentials`: Include credentials for extra indices.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Poetry plugin to export the dependencies to various formats",
    "version": "1.8.0",
    "project_urls": {
        "Homepage": "https://python-poetry.org/",
        "Repository": "https://github.com/python-poetry/poetry-plugin-export"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "de551dd7c8c955d71f58a9202c37bf8e037d697dc9f11a9a2ade65663251ee44",
                "md5": "d6ac4aeaefbe4057c0bf64fac980d4b9",
                "sha256": "adbe232cfa0cc04991ea3680c865cf748bff27593b9abcb1f35fb50ed7ba2c22"
            },
            "downloads": -1,
            "filename": "poetry_plugin_export-1.8.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d6ac4aeaefbe4057c0bf64fac980d4b9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 10795,
            "upload_time": "2024-05-11T16:11:34",
            "upload_time_iso_8601": "2024-05-11T16:11:34.197319Z",
            "url": "https://files.pythonhosted.org/packages/de/55/1dd7c8c955d71f58a9202c37bf8e037d697dc9f11a9a2ade65663251ee44/poetry_plugin_export-1.8.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "81bf270ef984c6f4b610a22a6948096b6b9d949de8f77c4c427d981c530ac521",
                "md5": "6922a6ae52e108f357288f2d70f17bc6",
                "sha256": "1fa6168a85d59395d835ca564bc19862a7c76061e60c3e7dfaec70d50937fc61"
            },
            "downloads": -1,
            "filename": "poetry_plugin_export-1.8.0.tar.gz",
            "has_sig": false,
            "md5_digest": "6922a6ae52e108f357288f2d70f17bc6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 29840,
            "upload_time": "2024-05-11T16:11:35",
            "upload_time_iso_8601": "2024-05-11T16:11:35.643908Z",
            "url": "https://files.pythonhosted.org/packages/81/bf/270ef984c6f4b610a22a6948096b6b9d949de8f77c4c427d981c530ac521/poetry_plugin_export-1.8.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-11 16:11:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "python-poetry",
    "github_project": "poetry-plugin-export",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "poetry-plugin-export"
}
Sébastien Eustace
Elapsed time: 1.24312s