Propper naming of requirements files (getsentry#3191)

arjennienhuis · Sep 30, 2024 · 9855980 · 9855980
1 parent 193d9a7
commit 9855980
Show file tree

Hide file tree

Showing 10 changed files with 11 additions and 11 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -63,7 +63,7 @@ This will make sure that your commits will have the correct coding style.
 ```bash
 cd sentry-python
 
-pip install -r devenv-requirements.txt
+pip install -r requirements-devenv.txt
 
 pip install pre-commit
 

diff --git a/Makefile b/Makefile
@@ -50,7 +50,7 @@ lint: .venv
 
 apidocs: .venv
 	@$(VENV_PATH)/bin/pip install --editable .
-	@$(VENV_PATH)/bin/pip install -U -r ./docs-requirements.txt
+	@$(VENV_PATH)/bin/pip install -U -r ./requirements-docs.txt
 	rm -rf docs/_build
 	@$(VENV_PATH)/bin/sphinx-build -vv -W -b html docs/ docs/_build
 .PHONY: apidocs
@@ -61,6 +61,6 @@ apidocs-hotfix: apidocs
 .PHONY: apidocs-hotfix
 
 aws-lambda-layer: dist
-	$(VENV_PATH)/bin/pip install -r aws-lambda-layer-requirements.txt
+	$(VENV_PATH)/bin/pip install -r requirements-aws-lambda-layer.txt
 	$(VENV_PATH)/bin/python -m scripts.build_aws_lambda_layer
 .PHONY: aws-lambda-layer
diff --git a/aws-lambda-layer-requirements.txt → requirements-aws-lambda-layer.txt b/aws-lambda-layer-requirements.txt → requirements-aws-lambda-layer.txt
diff --git a/devenv-requirements.txt → requirements-devenv.txt b/devenv-requirements.txt → requirements-devenv.txt
@@ -1,5 +1,5 @@
--r linter-requirements.txt
--r test-requirements.txt
+-r requirements-linting.txt
+-r requirements-testing.txt
 mockupdb # required by `pymongo` tests that are enabled by `pymongo` from linter requirements
 pytest<7.0.0 # https://github.com/pytest-dev/pytest/issues/9621; see tox.ini
 pytest-asyncio
diff --git a/docs-requirements.txt → requirements-docs.txt b/docs-requirements.txt → requirements-docs.txt
diff --git a/linter-requirements.txt → requirements-linting.txt b/linter-requirements.txt → requirements-linting.txt
diff --git a/test-requirements.txt → requirements-testing.txt b/test-requirements.txt → requirements-testing.txt
diff --git a/scripts/build_aws_lambda_layer.py b/scripts/build_aws_lambda_layer.py
@@ -44,7 +44,7 @@ def install_python_packages(self):
                 "pip",
                 "install",
                 "-r",
-                "aws-lambda-layer-requirements.txt",
+                "requirements-aws-lambda-layer.txt",
                 "--target",
                 self.python_site_packages,
             ],

diff --git a/tests/integrations/aws_lambda/client.py b/tests/integrations/aws_lambda/client.py
@@ -36,7 +36,7 @@ def _install_dependencies(base_dir, subprocess_kwargs):
             "pip",
             "install",
             "-r",
-            "aws-lambda-layer-requirements.txt",
+            "requirements-aws-lambda-layer.txt",
             "--target",
             base_dir,
         ],
@@ -68,7 +68,7 @@ def _install_dependencies(base_dir, subprocess_kwargs):
         **subprocess_kwargs,
     )
     # Install the created Sentry SDK source distribution into the target directory
-    # Do not install the dependencies of the SDK, because they where installed by aws-lambda-layer-requirements.txt above
+    # Do not install the dependencies of the SDK, because they where installed by requirements-aws-lambda-layer.txt above
     source_distribution_archive = glob.glob(
         "{}/*.tar.gz".format(os.path.dirname(base_dir))
     )[0]

diff --git a/tox.ini b/tox.ini
@@ -252,12 +252,12 @@ envlist =
 
 [testenv]
 deps =
-    # if you change test-requirements.txt and your change is not being reflected
+    # if you change requirements-testing.txt and your change is not being reflected
     # in what's installed by tox (when running tox locally), try running tox
     # with the -r flag
-    -r test-requirements.txt
+    -r requirements-testing.txt
 
-    linters: -r linter-requirements.txt
+    linters: -r requirements-linting.txt
     linters: werkzeug<2.3.0
 
     # === Common ===