https://github.com/ryan-rozario/pipreqs-action

Automatically creates the requirement.txt file for your python project using Github Actions and pipreqs
https://github.com/ryan-rozario/pipreqs-action

github-actions python requirements-management software-engineering

Last synced: about 1 month ago
JSON representation

Automatically creates the requirement.txt file for your python project using Github Actions and pipreqs

• Host: GitHub
• URL: https://github.com/ryan-rozario/pipreqs-action
• Owner: ryan-rozario
• License: mit
• Created: 2020-03-30T14:11:04.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-08-08T20:39:42.000Z (over 1 year ago)
• Last Synced: 2025-04-02T15:17:37.897Z (about 1 month ago)
• Topics: github-actions, python, requirements-management, software-engineering
• Language: Shell
• Homepage:
• Size: 26.4 KB
• Stars: 17
• Watchers: 1
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Automatic requirement.txt for Python Projects on Github

[pipreqs](https://github.com/bndr/pipreqs) - Generates pip requirements.txt file based on imports of any project.

This action will automatically create the requirements.txt file for a python project using the pipreqs tool.

You can specify the location of your project folder that contains all the python files within your repository.

You can specify the path to which your requirement.txt has to be saved.

## Usage

### Example workflow

```yaml

name: Integration Test

on: [push]

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@master

      - name: Automatic requirements.txt for Python Project

        uses: ryan-rozario/pipreqs-action@master

        # Put an example of mandatory inputs here

        with:

          PROJECT_PATH: project_folder   #default is the root of the repository

          REQUIREMENT_PATH: project_folder/requirements.txt  #default is requirement.txt in the root of your repository 

```

### Inputs

| Input                                             | Description                                        |Default                                        |

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

| `PROJECT_PATH`  | Gives the path to the project folder that contains the python files    |  .

| `REQUIREMENT_PATH`  | Gives the path to the location where requirements.txt has to be saved, including the requirements.txt file name    | requirements.txt|

| `PROJECT_NAME`  | Includes the project name in the commit  | project_name |