fix(build): do not include docs in wheel package

nejch · JohnVillalovos · commit 68a97ced5210 · 2021-10-31T07:49:41.000-07:00
diff --git a/setup.py b/setup.py
@@ -24,7 +24,7 @@ def get_version():
     author_email="gauvain@pocentek.net",
     license="LGPLv3",
     url="https://github.com/python-gitlab/python-gitlab",
-    packages=find_packages(exclude=["tests*"]),
+    packages=find_packages(exclude=["docs*", "tests*"]),
     install_requires=["requests>=2.25.0", "requests-toolbelt>=0.9.1"],
     package_data={
         "gitlab": ["py.typed"],
diff --git a/tests/smoke/test_dists.py b/tests/smoke/test_dists.py
@@ -9,6 +9,7 @@
 from gitlab import __title__, __version__
 
 DIST_DIR = Path("dist")
+DOCS_DIR = "docs"
 TEST_DIR = "tests"
 SDIST_FILE = f"{__title__}-{__version__}.tar.gz"
 WHEEL_FILE = (
@@ -18,8 +19,8 @@
 
 @pytest.fixture(scope="function")
 def build():
-    sandbox.run_setup("setup.py", ["clean", "--all"])
-    return sandbox.run_setup("setup.py", ["sdist", "bdist_wheel"])
+    sandbox.run_setup("setup.py", ["--quiet", "clean", "--all"])
+    return sandbox.run_setup("setup.py", ["--quiet", "sdist", "bdist_wheel"])
 
 
 def test_sdist_includes_tests(build):
@@ -28,6 +29,6 @@ def test_sdist_includes_tests(build):
     assert test_dir.isdir()
 
 
-def test_wheel_excludes_tests(build):
+def test_wheel_excludes_docs_and_tests(build):
     wheel = zipfile.ZipFile(DIST_DIR / WHEEL_FILE)
-    assert [not file.startswith(TEST_DIR) for file in wheel.namelist()]
+    assert not any([file.startswith((DOCS_DIR, TEST_DIR)) for file in wheel.namelist()])
