chore(packaging): Convert project to src-layout (#736)

* Drop top import package deprecation warning

This patch puts it directly into the check script.

In general, it's harmful to have such logic in `__init__.py` since
it's executed at import time and would get triggered when interacting
with other importables from the same namespace just as well.

* Convert project to src-layout

This is one of the most resilient Python project structures that
offers isolation and prevents accidental local imports during testing
[[1]].

[1]: https://blog.ganssle.io/articles/2019/08/test-as-installed.html

Author: webknjaz

hatch.toml

@@ -1,14 +1,11 @@
 [build.targets.sdist]
 include = [
-  'hooks/*.py',
-]
-exclude = [
-  'hooks/*.sh',
+  'src/',
 ]
 
 [build.targets.wheel]
 packages = [
-  'hooks/',
+  'src/pre_commit_terraform/',
 ]
 
 [metadata.hooks.vcs.urls]

hooks/__init__.py

@@ -33,4 +33,4 @@ file = 'README.md'
 content-type = 'text/markdown'
 
 [project.scripts]
-terraform_docs_replace = 'hooks.terraform_docs_replace:main'
+terraform_docs_replace = 'pre_commit_terraform.terraform_docs_replace:main'

pyproject.toml

@@ -2,6 +2,7 @@
 import os
 import subprocess
 import sys
+import warnings
 
 
 def main(argv=None):
@@ -27,6 +28,14 @@ def main(argv=None):
     parser.add_argument('filenames', nargs='*', help='Filenames to check.')
     args = parser.parse_args(argv)
 
+    warnings.warn(
+        '`terraform_docs_replace` hook is DEPRECATED.'
+        'For migration instructions see '
+        'https://github.com/antonbabenko/pre-commit-terraform/issues/248'
+        '#issuecomment-1290829226',
+        category=UserWarning,
+    )
+
     dirs = []
     for filename in args.filenames:
         if (os.path.realpath(filename) not in dirs and