https://github.com/divkix/poetry-export-requirements-action

GitHub action to export requirements.txt file from pyproject.toml file 📝
https://github.com/divkix/poetry-export-requirements-action

github-actions poetry pyproject-toml python python-poetry requirements-txt-pip

Last synced: 6 days ago
JSON representation

GitHub action to export requirements.txt file from pyproject.toml file 📝

• Host: GitHub
• URL: https://github.com/divkix/poetry-export-requirements-action
• Owner: Divkix
• License: mit
• Created: 2022-06-12T09:16:07.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-07T09:59:23.000Z (8 months ago)
• Last Synced: 2024-10-10T16:49:52.671Z (about 1 month ago)
• Topics: github-actions, poetry, pyproject-toml, python, python-poetry, requirements-txt-pip
• Homepage: https://github.com/marketplace/actions/poetry-export-requirements-txt-file
• Size: 19.5 KB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Poetry export requirements.txt file

This action prints exports the pyproject.toml and poetry.lock file to the requirements.txt file.

## Inputs

| Name           | Required | Description                                                          | Default          |

| -------------- | -------- | -------------------------------------------------------------------- | ---------------- |

| without-hashes | false    | If you want to use '--without-hashes' option when exporting the file | true             |

| outfile-name   | false    | Custom name for exported file                                        | requirements.txt |

## Outputs

`custom-file-name`: Name of the output file

The current working directory will have a `requirements.txt` file generated from the pyproject.toml and poetry.lock files.

## Example usage

```yaml

name: poetry export requirements.txt

on:

  pull_request:

  push:

    branches: [main]

jobs:

  export-requirements-txt:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v3

    - uses: divideprojects/poetry-export-requirements-action@v1

      with:

        without-hashes: true

        outfile-name: requirements.txt

```

Make sure to use `actions/checkout@3` as the first action in your pipeline.