Convert to a src layout.

See: https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure
cisagov · May 5, 2019 · 797a699 · 797a699
1 parent 62bbd80
commit 797a699
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/setup.py b/setup.py
@@ -5,9 +5,13 @@
 
 - https://packaging.python.org/distributing/
 - https://github.com/pypa/sampleproject/blob/master/setup.py
+- https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure
 """
 
-from setuptools import setup
+from glob import glob
+from os.path import splitext, basename
+
+from setuptools import setup, find_packages
 
 
 def readme():
@@ -50,7 +54,10 @@ def readme():
     ],
     # What does your project relate to?
     keywords="skeleton",
-    packages=["example"],
+    packages=find_packages(where="src"),
+    package_dir={"": "src"},
+    py_modules=[splitext(basename(path))[0] for path in glob("src/*.py")],
+    include_package_data=True,
     install_requires=["docopt"],
     extras_require={"test": ["pre-commit", "pytest", "pytest-cov", "coveralls"]},
     # Conveniently allows one to run the CLI tool as `example`

diff --git a/example/__init__.py → src/example/__init__.py b/example/__init__.py → src/example/__init__.py
diff --git a/example/example.py → src/example/example.py b/example/example.py → src/example/example.py