Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
mnschmit committed Jun 16, 2023
1 parent ed70c6b commit d668a62
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,13 @@
# setup-pipenv
A GitHub action to setup and activate a virtual environment with pipenv

A GitHub action to install python and setup + activate a virtual environment with pipenv.
Other than existing pipenv GitHub actions, the virtual environment is activated after it is set up.
So the rest of the workflow doesn't need to know that pipenv was used in creating the environment.

## Inputs

- `python-version`: The Python version to use (e.g., `3.9`)
- `additional-dependencies`: (optional) A list of python libraries to be installed via pip
after setting up the virtual environment with the dependencies from `Pipfile.lock`.
This might be useful if there are certain dependencies only for the workflow
that are not needed for the rest of the project.

0 comments on commit d668a62

Please sign in to comment.