mraba/snyk-support-requirements: add requirements.txt file for snyk scanning (snowflakedb#491)

* mraba/snyk-support-requirements: add requirements.txt file for snyk scanning

* mraba/snyk-support-requirements: add script for generating requirements and filename fix

* mraba/snyk-support-requirements: finish last line with new line

* mraba/snyk-support-requirements: add pre-commit hook for auto generating requirements.txt

Author: sfc-gh-mraba

.pre-commit-config.yaml

@@ -44,3 +44,10 @@ repos:
       - id: flake8
         additional_dependencies:
           - flake8-bugbear
+-   repo: local
+    hooks:
+      - id: requirements-update
+        name: "Update dependencies from pyproject.toml to snyk/requirements.txt"
+        language: system
+        entry: python snyk/update_requirements.py
+        files: ^pyproject.toml$

pyproject.toml

@@ -38,7 +38,7 @@ classifiers = [
   "Topic :: Software Development :: Libraries :: Application Frameworks",
   "Topic :: Software Development :: Libraries :: Python Modules",
 ]
-dependencies = ["snowflake-connector-python<4.0.0", "SQLAlchemy>=1.4.19,<2.0.0"]
+dependencies = ["SQLAlchemy>=1.4.19,<2.0.0", "snowflake-connector-python<4.0.0"]
 
 [tool.hatch.version]
 path = "src/snowflake/sqlalchemy/version.py"

snyk/requirements.txt

@@ -0,0 +1,2 @@
+SQLAlchemy>=1.4.19,<2.0.0
+snowflake-connector-python<4.0.0

snyk/update_requirements.py

@@ -0,0 +1,17 @@
+from pathlib import Path
+
+import tomlkit
+
+
+def sync():
+    pyproject = tomlkit.loads(Path("pyproject.toml").read_text())
+    snyk_reqiurements = Path("snyk/requirements.txt")
+    dependencies = pyproject.get("project", {}).get("dependencies", [])
+
+    with snyk_reqiurements.open("w") as fh:
+        fh.write("\n".join(dependencies))
+        fh.write("\n")
+
+
+if __name__ == "__main__":
+    sync()