fix

Author: edublancas

src/pkgmt/assets/template/src/package_name/cli.py

@@ -22,6 +22,7 @@ def hello(name):
 @click.argument("name")
 def log(name):
     """Log a message"""
+    # flake8: noqa
     from $package_name.log import configure_file_and_print_logger, get_logger
 
     configure_file_and_print_logger()

src/pkgmt/assets/template/src/package_name/log.py

@@ -13,7 +13,6 @@
 """
 
 import logging
-import structlog
 from typing import Any, TextIO
 import os
 

src/pkgmt/new.py

@@ -53,3 +53,23 @@ def package(name, use_setup_py=False):
         (root / "MANIFEST.in").unlink()
         (root / "pyproject-setup.toml").rename(root / "pyproject.toml")
         (root / "src" / package_name / "__init__.py").write_text("")
+
+    # Remove flake8: noqa comments from Python files, we added them because
+    # they contain $TAG, which raises a warning when linting
+    for py_file in root.rglob("*.py"):
+        content = py_file.read_text()
+        lines = content.splitlines()
+
+        # Process each line
+        new_lines = []
+        for line in lines:
+            # Skip lines that only contain the noqa comment
+            if line.strip() == "# flake8: noqa":
+                continue
+            # Remove the noqa substring from other lines
+            new_line = line.replace("# flake8: noqa", "").rstrip()
+            if new_line:
+                new_lines.append(new_line)
+
+        # Write back the cleaned content
+        py_file.write_text("\n".join(new_lines) + "\n")

tests/test_new.py

@@ -23,7 +23,7 @@ def test_package_setup_py(tmp_empty, uninstall):
     ci = Path("some-cool-pkg", ".github", "workflows", "ci.yml").read_text()
     manifest = Path("some-cool-pkg", "MANIFEST.in").read_text()
     init = Path("some-cool-pkg", "src", "some_cool_pkg", "__init__.py").read_text()
-
+    cli = Path("some-cool-pkg", "src", "some_cool_pkg", "cli.py").read_text()
     assert '__version__ = "0.1dev"\n' == init
     assert 'github = "ploomber/some-cool-pkg"' in pyproject
     assert 'package_name = "some_cool_pkg"' in pyproject
@@ -32,6 +32,7 @@ def test_package_setup_py(tmp_empty, uninstall):
     assert "src/some_cool_pkg/__init__.py" in setup
     assert 'python -c "import some_cool_pkg"' in ci
     assert "graft src/some_cool_pkg/assets" in manifest
+    assert "# flake8: noqa" not in cli
 
     subprocess.check_call(["some-cool-pkg", "log", "user"])
     assert json.loads(Path("app.log").read_text()) == {
@@ -50,12 +51,12 @@ def test_package_pyproject_toml(tmp_empty, uninstall):
     pyproject = Path("some-cool-pkg", "pyproject.toml").read_text()
     ci = Path("some-cool-pkg", ".github", "workflows", "ci.yml").read_text()
     init = Path("some-cool-pkg", "src", "some_cool_pkg", "__init__.py").read_text()
-
+    cli = Path("some-cool-pkg", "src", "some_cool_pkg", "cli.py").read_text()
     assert not Path("some-cool-pkg", "setup.py").exists()
     assert not Path("some-cool-pkg", "MANIFEST.in").exists()
     assert not Path("some-cool-pkg", "pyproject-setup.toml").exists()
 
-    assert init == ""
+    assert init == "\n"
 
     assert 'github = "ploomber/some-cool-pkg"' in pyproject
     assert 'package_name = "some_cool_pkg"' in pyproject
@@ -66,6 +67,7 @@ def test_package_pyproject_toml(tmp_empty, uninstall):
     assert 'package-data = { "some_cool_pkg" = ["assets/*", "*.md"] }' in pyproject
 
     assert 'python -c "import some_cool_pkg"' in ci
+    assert "# flake8: noqa" not in cli
 
     subprocess.check_call(["some-cool-pkg", "log", "user"])
     assert json.loads(Path("app.log").read_text()) == {