Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add details for running against pipenv projects #364

Merged
merged 4 commits into from
Sep 8, 2022

Conversation

ameily
Copy link
Contributor

@ameily ameily commented Sep 2, 2022

I have a pipenv project that I wanted to run pip-audit against. I found a simple workaround to convert the Pipfile[.lock] to a compatible requirements.txt file that pip-audit can process. I documented how I got this working in hopes it can help others with pipenv based projects. I've verified that the commands I added work properly, for both running locally and within GitHub CI.

Refs #85

@ameily
Copy link
Contributor Author

ameily commented Sep 2, 2022

CC @woodruffw

@tetsuo-cpp
Copy link
Contributor

tetsuo-cpp commented Sep 2, 2022

@woodruffw @di
I remember at some point we had plans to support pipenv and Poetry natively. Do we still want to do this, and if so maybe we should mention it here?

Edit: Oh, I see you linked the relevant issue.

Copy link
Member

@woodruffw woodruffw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's break this out a bit: I think we want a separate "Tips and tricks" section, with this as a subsection.

README.md Outdated Show resolved Hide resolved
@woodruffw woodruffw self-assigned this Sep 2, 2022
@woodruffw woodruffw added the component:docs Documentation components label Sep 2, 2022
Copy link
Member

@woodruffw woodruffw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @ameily!

Copy link
Member

@di di left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some nits

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@woodruffw
Copy link
Member

woodruffw commented Sep 8, 2022

Sorry, one last nit 😅 -- otherwise LGTM.

Co-authored-by: William Woodruff <[email protected]>
@di di requested a review from woodruffw September 8, 2022 16:23
@woodruffw woodruffw merged commit c582937 into pypa:main Sep 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants