refactor: Move to src/ layout (#814)

Author: tony

docs/conf.py

@@ -10,13 +10,14 @@
 # Get the project root dir, which is the parent dir of this
 cwd = Path(__file__).parent
 project_root = cwd.parent
+src_root = project_root / "src"
 
-sys.path.insert(0, str(project_root))
+sys.path.insert(0, str(src_root))
 sys.path.insert(0, str(cwd / "_ext"))
 
 # package data
 about: t.Dict[str, str] = {}
-with open(project_root / "tmuxp" / "__about__.py") as fp:
+with open(src_root / "tmuxp" / "__about__.py") as fp:
     exec(fp.read(), about)
 
 extensions = [
@@ -215,16 +216,18 @@ def linkcode_resolve(domain, info):  # NOQA: C901
     fn = relpath(fn, start=dirname(tmuxp.__file__))
 
     if "dev" in about["__version__"]:
-        return "{}/blob/master/{}/{}{}".format(
+        return "{}/blob/master/{}/{}/{}{}".format(
             about["__github__"],
+            "src",
             about["__package_name__"],
             fn,
             linespec,
         )
     else:
-        return "{}/blob/v{}/{}/{}{}".format(
+        return "{}/blob/v{}/{}/{}/{}{}".format(
             about["__github__"],
             about["__version__"],
+            "src",
             about["__package_name__"],
             fn,
             linespec,

pyproject.toml

@@ -24,7 +24,7 @@ keywords = ["tmux", "session manager", "terminal", "ncurses"]
 homepage = "http://github.com/tmux-python/tmuxp/"
 readme = "README.md"
 packages = [
-  { include = "tmuxp" },
+  { include = "*", from = "src" },
 ]
 include = [
   { path = "CHANGES", format = "sdist" },

setup.cfg

@@ -1,5 +1,5 @@
 [flake8]
-exclude = .*/,*.egg,tmuxp/_compat.py,tmuxp/__*__.py,
+exclude = .*/,*.egg,src/tmuxp/_compat.py,src/tmuxp/__*__.py,
 select = E,W,F,N
 max-line-length = 88
 # Stuff we ignore thanks to black: https://github.com/ambv/black/issues/429
@@ -22,6 +22,6 @@ filterwarnings =
 addopts = --reruns=0 --tb=short --no-header --showlocals --doctest-modules
 doctest_optionflags = ELLIPSIS NORMALIZE_WHITESPACE
 testpaths =
-	tmuxp
+	src/tmuxp
 	tests
 	docs