refactor!: Move to src/ layout (#7)

Author: tony

CHANGES

@@ -21,6 +21,7 @@ $ pipx install --suffix=@next g --pip-args '\--pre' --force
 
 ### Development
 
+- Move to `src/` layout (#7)
 - Add [flake8-bugbear](https://github.com/PyCQA/flake8-bugbear) (#4)
 - Add [flake8-comprehensions](https://github.com/adamchainz/flake8-comprehensions) (#5)
 

docs/conf.py

@@ -11,13 +11,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 / "g" / "__about__.py") as fp:
+with open(src_root / "g" / "__about__.py") as fp:
     exec(fp.read(), about)
 
 extensions = [
@@ -210,16 +211,18 @@ def linkcode_resolve(
     fn = relpath(fn, start=dirname(g.__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

@@ -21,7 +21,7 @@ classifiers = [
   "Topic :: System :: Shells",
 ]
 packages = [
-  { include = "g" },
+  { include = "*", from = "src" },
 ]
 include = [
   { path = "tests", format = "sdist" },

setup.cfg

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