Skip to content

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

License

Notifications You must be signed in to change notification settings

ryan-rozario/pipreqs-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Automatic requirement.txt for Python Projects on Github

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

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