Migrate examples to src-layout

pypa · Nov 29, 2023 · c255b01 · c255b01
1 parent b0a98d0
commit c255b01
Show file tree

Hide file tree

Showing 17 changed files with 15 additions and 9 deletions.
diff --git a/native/pkg_a/setup.py b/native/pkg_a/setup.py
@@ -27,7 +27,8 @@
     author_email='[email protected]',
 
     license='Apache Software License',
-
-    packages=['example_pkg.a'],
+    # This example uses automatic discovery. You can also implement custom discovery like this:
+    # packages=find_namespace_packages(where='src', include=['example_pkg.a']),
+    # package_dir={'': 'src'},
     zip_safe=False,
 )
diff --git a/native/pkg_a/example_pkg/a/__init__.py → native/pkg_a/src/example_pkg/a/__init__.py b/native/pkg_a/example_pkg/a/__init__.py → native/pkg_a/src/example_pkg/a/__init__.py
diff --git a/native/pkg_b/setup.py b/native/pkg_b/setup.py
@@ -27,7 +27,8 @@
     author_email='[email protected]',
 
     license='Apache Software License',
-
-    packages=['example_pkg.b'],
+    # This example uses automatic discovery. You can also implement custom discovery like this:
+    # packages=find_namespace_packages(where='src', include=['example_pkg.b']),
+    # package_dir={'': 'src'},
     zip_safe=False,
 )
diff --git a/native/pkg_b/example_pkg/b/__init__.py → native/pkg_b/src/example_pkg/b/__init__.py b/native/pkg_b/example_pkg/b/__init__.py → native/pkg_b/src/example_pkg/b/__init__.py
diff --git a/pkg_resources/pkg_a/setup.py b/pkg_resources/pkg_a/setup.py
@@ -28,7 +28,8 @@
 
     license='Apache Software License',
 
-    packages=find_packages(),
+    packages=find_packages(where='src'),
     namespace_packages=['example_pkg'],
+    package_dir={'': 'src'},
     zip_safe=False,
 )
diff --git a/pkg_resources/pkg_a/example_pkg/__init__.py → ...sources/pkg_a/src/example_pkg/__init__.py b/pkg_resources/pkg_a/example_pkg/__init__.py → ...sources/pkg_a/src/example_pkg/__init__.py
diff --git a/...resources/pkg_a/example_pkg/a/__init__.py → ...urces/pkg_a/src/example_pkg/a/__init__.py b/...resources/pkg_a/example_pkg/a/__init__.py → ...urces/pkg_a/src/example_pkg/a/__init__.py
diff --git a/pkg_resources/pkg_b/setup.py b/pkg_resources/pkg_b/setup.py
@@ -28,7 +28,8 @@
 
     license='Apache Software License',
 
-    packages=find_packages(),
+    packages=find_packages(where='src'),
     namespace_packages=['example_pkg'],
+    package_dir={'': 'src'},
     zip_safe=False,
 )
diff --git a/pkg_resources/pkg_b/example_pkg/__init__.py → ...sources/pkg_b/src/example_pkg/__init__.py b/pkg_resources/pkg_b/example_pkg/__init__.py → ...sources/pkg_b/src/example_pkg/__init__.py
diff --git a/...resources/pkg_b/example_pkg/b/__init__.py → ...urces/pkg_b/src/example_pkg/b/__init__.py b/...resources/pkg_b/example_pkg/b/__init__.py → ...urces/pkg_b/src/example_pkg/b/__init__.py
diff --git a/pkgutil/README.md b/pkgutil/README.md
@@ -61,5 +61,5 @@ cd pkgutil/pkg_a
 pip install .
 
 # Test the install by printing the `name` from the `__init__.py` file.
-python -c "import example_pkg.a as a; print a.name"
+python -c "import example_pkg.a as a; print(a.name)"
 ```
diff --git a/pkgutil/pkg_a/setup.py b/pkgutil/pkg_a/setup.py
@@ -28,6 +28,7 @@
 
     license='Apache Software License',
 
-    packages=find_packages(),
+    packages=find_packages(where='src'),
+    package_dir={'': 'src'},
     zip_safe=False,
 )
diff --git a/pkgutil/pkg_a/example_pkg/__init__.py → pkgutil/pkg_a/src/example_pkg/__init__.py b/pkgutil/pkg_a/example_pkg/__init__.py → pkgutil/pkg_a/src/example_pkg/__init__.py
diff --git a/pkgutil/pkg_a/example_pkg/a/__init__.py → pkgutil/pkg_a/src/example_pkg/a/__init__.py b/pkgutil/pkg_a/example_pkg/a/__init__.py → pkgutil/pkg_a/src/example_pkg/a/__init__.py
diff --git a/pkgutil/pkg_b/setup.py b/pkgutil/pkg_b/setup.py
@@ -28,6 +28,7 @@
 
     license='Apache Software License',
 
-    packages=find_packages(),
+    packages=find_packages(where='src'),
+    package_dir={'': 'src'},
     zip_safe=False,
 )
diff --git a/pkgutil/pkg_b/example_pkg/__init__.py → pkgutil/pkg_b/src/example_pkg/__init__.py b/pkgutil/pkg_b/example_pkg/__init__.py → pkgutil/pkg_b/src/example_pkg/__init__.py
diff --git a/pkgutil/pkg_b/example_pkg/b/__init__.py → pkgutil/pkg_b/src/example_pkg/b/__init__.py b/pkgutil/pkg_b/example_pkg/b/__init__.py → pkgutil/pkg_b/src/example_pkg/b/__init__.py