-
-
Notifications
You must be signed in to change notification settings - Fork 0
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
chore(readme): sentry-infra-tools in editable mode #34
base: main
Are you sure you want to change the base?
Conversation
@@ -16,4 +16,5 @@ referencing>=0.35.1 | |||
Requests>=2.32.3 | |||
sentry_jsonnet>=0.0.4 | |||
sentry_sdk>=2.10.0 | |||
setuptools>=69.0.3 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is needed since sentry-kube uses pkg_resources
in the code
README.md
Outdated
2. Install the local working copy of sentry-infra-tools in editable mode. | ||
|
||
```shell | ||
pip install -e ~/sentry-infra-tools |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't it work if we just asked people to make a change to requirements.in/txt and reference the local copy instead?
With this approach refreshing dependencies in the ops repo (devenv sync) would remove the local copy and go back to the public one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added the additional instructions on how to work with requirements.txt file. Since sentry-infra-tools is public, I want the instructions to be generic and not catered only towards the ops repo (even though it is setup like that today).
Description
This PR adds contents to the README file with regards to how to install sentry-infra-tools in editable mode. Editable mode may be desired when developing software on sentry-kube but wanting to test in some other virtual environment.
Testing
Created a new virtual environment. Installed the regular sentry-infra-tools package from pypi. Then removed the package from virtual environment and installed the local residing sentry-infra-tools package. Removed the
kube
output to see thatsentry-kube --help
indeed took the change into effect. The diff used for testing wasLogs of the tests are below