Skip to content

Standardise installation instructions - #12

Merged
hermanerr merged 2 commits into
OpenVanta:mainfrom
tom-leverstone:main
Aug 10, 2026
Merged

Standardise installation instructions#12
hermanerr merged 2 commits into
OpenVanta:mainfrom
tom-leverstone:main

Conversation

@tom-leverstone

@tom-leverstone tom-leverstone commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Summary

Hi team! Nice work. I was following the installation instructions requiring git and cloning felt really odd. It's not a common practice in python (as far as I can tell, and not sure if it's common in other communities). Ideally, it would be nice to have this on PyPI. But with uv we can get quite far without as it can install and run directly from GitHub.

This PR does just that: adding an entry script and updating the README with the new running instruction.

AI usage

Claude Code wrote the change w/ Sonnet 4.6 to the prompt

The installation instructions on this repo are very much... non-pythonic. We don't need pypi if we don't want to, but we should be able to run the project without cloning with something like uvx --from git+https://github.com/OpenVanta/GrantGuard grantguard.

For that to work we need to change pyproject.toml slightly so grantguard is a command. Then we can update the README. Makes sense?

Testing

Verified locally by running verified by running uvx --from /Users/tomleverstone/code/GrantGuard grantguard`.

Related issue

None

Type of change

  • Bug fix
  • New risk detector / detection improvement
  • New feature
  • Docs / chore

Checklist

  • uv run python -m compileall -q grantguard grantguard.py passes
  • No new runtime dependencies (stdlib only)
  • New secret-matching patterns are also covered by redact()
  • Docs updated if behavior changed
  • I verified the change manually (CLI and/or UI)

@tom-leverstone
tom-leverstone requested a review from a team as a code owner July 8, 2026 08:30
@hermanerr
hermanerr merged commit e833033 into OpenVanta:main Aug 10, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants