https://github.com/python-poetry/poetry-plugin-export

Poetry plugin to export the dependencies to various formats
https://github.com/python-poetry/poetry-plugin-export

poetry poetry-plugin python

Last synced: 6 days ago
JSON representation

Poetry plugin to export the dependencies to various formats

• Host: GitHub
• URL: https://github.com/python-poetry/poetry-plugin-export
• Owner: python-poetry
• License: mit
• Created: 2021-05-21T15:29:52.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T23:31:19.000Z (about 2 months ago)
• Last Synced: 2024-10-29T15:52:44.458Z (about 2 months ago)
• Topics: poetry, poetry-plugin, python
• Language: Python
• Size: 472 KB
• Stars: 244
• Watchers: 9
• Forks: 54
• Open Issues: 61
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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.

* `--with`: The optional and non-optional dependency groups to include. By default, only the main dependencies are included.

* `--only`: The only dependency groups to include. It is possible to exclude the `main` group this way.

* `--without`: The dependency groups to ignore. (**Deprecated**)

* `--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.

* `--all-groups`: Include all dependency groups.

* `--without-hashes`: Exclude hashes from the exported file.

* `--with-credentials`: Include credentials for extra indices.