Add support for projects with namespace packages #40

jaraco · 2021-01-16T00:15:24Z

I believe Setuptools can support projects that optionally have namespace packages with the find_namespace directive. It requires adding some ignores to avoid including non-project directories in the install.

I've tested on a few projects and the following patch seems to do the trick in the general case:

diff --git a/setup.cfg b/setup.cfg
index 88bc263..106763e 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -15,12 +15,18 @@ classifiers =
 	Programming Language :: Python :: 3 :: Only
 
 [options]
-packages = find:
+packages = find_namespace:
 include_package_data = true
 python_requires = >=3.6
 install_requires =
 setup_requires = setuptools_scm[toml] >= 3.4.1
 
+[options.packages.find]
+exclude =
+        build*
+        docs*
+        tests*
+
 [options.extras_require]
 testing =
 	# upstream

It's a little verbose for my taste, but these changes are necessary to support namespace packages, so better to have common config for all projects.

The text was updated successfully, but these errors were encountered:

…on 51.3.3 Daniel Moore (1): Clarify Development Mode first paragraph Drew (1): docs (build_meta): fix spelling mistake Dustin Ingram (3): Move helper method out of class Add failing test Correctly handle normalized tags Henry Schreiner (1): fix: suggest PyPA build instead of pep517.build Jason R. Coombs (22): pre-commit autoupdate Rename 'Automated Tests' to simply 'tests' Add note about automatic merging of PRs and the requirements and limitations. Prefer pytest-enabler to jaraco.test Enable complexity limit. Fixes jaraco/skeleton#34. Add support for namespace packages. Closes jaraco/skeleton#40. Avoid hitting network during test_easy_install Point changelog at 2534 for more info Bump version: 51.1.2 → 51.2.0 Point changelog at 2534 for more info Disable PIP_NO_INDEX for tests that override the index. Ref #2534. Exclude _distutils from flake8 also. Rely on tuple argument to endswith Remove unused variable Quick fix for #1390. Now description cannot contain a newline. Bump version: 51.2.0 → 51.3.0 Revert "Merge pull request #2533 from pypa/fix/2529" Bump version: 51.3.0 → 51.3.1 Repair Descriptions with newlines and emit a warning that the value will be disallowed in the future. Bump version: 51.3.1 → 51.3.2 Fix AttributeError in Description validation. Fixes #2539. Bump version: 51.3.2 → 51.3.3 Jonathan E (1): Fix code typo in entry_point.rst Miro Hrončok (1): Define create_module()/exec_module() in VendorImporter Petr Viktorin (1): Avoid deprecated load_module() in pkg_resources namespace delaration Sviatoslav Sydorenko (23): Migrate to `extend-exclude` in flake8 config Exclude `build/lib/` artifacts in flake8 config Fix misplaced/mistyped per-file-ignores in flake8 Drop non-existing site-patch.py from flake8 Drop unmached py*compat.py ignore rule from flake8 Use `extend-ignore` in flake8 config Use license_files instead of license_file in meta Simplify `setuptools.archive_util.unpack_tarfile` Simplify `easy_install.install_eggs` Simplify `easy_install.update_pth` Simplify `command.easy_install.get_site_dirs` Simplify `command.easy_install.expand_paths` Simplify `egg_info.FileList.process_template_line` Simplify `dist.Distribution._parse_config_files` Simplify `setuptools.glob._iglob` Simplify `setuptools.installer.fetch_build_egg` Simplify `msvc.SystemInfo.find_reg_vs_vers` Simplify `PackageIndex.process_index` Apply noqa C901 comments to overly complex code Enable McCabe complexity check in flake8 Replace pep517.build with build (#37) Use license_files instead of license_file in meta (#35) Use `extend-ignore` in flake8 config (#33) Tim Hatch (2): Failing test for #2489 Find .egg-info in zipimport too YuanPei Li (3): fix typo Create 2525.doc.rst Update 2525.doc.rst

….7.1 Jason R. Coombs (14): Honor TOX_WORK_DIR if set. Workaround for tox-dev/tox#20. Collapse skeleton history from archive/2020-12 Update skeleton description to describe the periodic collapse. Fixes #27. Enable automerge Automatically inject project name in docs heading. pre-commit autoupdate Rename 'Automated Tests' to simply 'tests' Add note about automatic merging of PRs and the requirements and limitations. Prefer pytest-enabler to jaraco.test Enable complexity limit. Fixes jaraco/skeleton#34. Add support for namespace packages. Closes jaraco/skeleton#40. Normalize indentation ⚫ Fade to black. Update changelog. Sviatoslav Sydorenko (3): Replace pep517.build with build (#37) Use license_files instead of license_file in meta (#35) Use `extend-ignore` in flake8 config (#33) vasyl_lukashuk (1): Fix error message

…on 5.3.0 Diego Elio Pettenò (1): Fix README (and thus long_description). Hugo (1): Fix AppVeyor typo Hugo van Kemenade (2): Spelling and capitalisation (#8) Link badge to PyPI rather than static image Jason R. Coombs (75): Add Tidelift template Rely on alabaster theme to support sidebar rendering. Use nicer, simpler phrasing Add support for automatic publishing of release notes Use technique for environment passing matching that found in jaraco/skeleton Move Tidelift token into Travis configuration Update badge URL Add funding reference to project List sidebars to avoid errors looking for template 't' Python 3 only Test/release on Python 3.8 Apply black to docs/conf.py Update black version and links Expect flake8 3.6 or later and remove suppression of warnings from Flake8 prior to 3.6. Rely on pytest-checkdocs 1.2.3, eliminating workaround for docutils warning. Remove workaround for gitlab.com/PyCQA/flake8/issues/275, apparently no longer necessary. Normalize indentation Include keyring support from twine Rename 'build-docs' to simply 'docs' (matching more popular convention). Prefer 'path' to 'path.py' Cover Python 3.8 in Windows tests Update black in pre-commit and add blacken-docs. Test and release using Azure Pipelines Correct guidance on project creation. Rely on setuptools_scm 3.4 and setuptools 42. Now setup.py is optional. Remove setuptools from test environment. Finish dropping support for Python 2 (I hope). Normalize whitespace Revert "setup.cfg: let python-tag mirror python_requires" Update to bionic for Travis. Correct comment about IPv6 workaround. Suppress warnings in pytest-flake8, pytest-black, and pytest-checkdocs. Prefer pytest-black to pytest-black-multipy Test against Windows and Mac Define a default pool_vm_image Remove tox-venv and tox-pip-version. Tox-venv is discouraged (tox-dev/tox-venv#48 (comment)) and tox-pip-version was only there to support tox-venv. venv is dead; long live virtualenv. Remove more references to tox-venv Add workaround for warning emitted when junitxml is used. Ref pytest-dev/pytest#6178. Include mypy for type checking during tests. Ensure virtualenv is upgraded when installing tox. Fixes jaraco/path#188. Run tests on prereleases of Python on Windows. Fixes jaraco/skeleton#17. Add workaround for python/mypy#8627. Fixes jaraco/skeleton#18. Add 'refresh.svg' demonstrating an example of refreshing a project with the latest skeleton. Ref #7. Move workaround for python/mypy#8627 to tox.ini, as adding it to setup.cfg prevents releases to PyPI. Fixes jaraco/skeleton#19. Remove workaround for python/mypy#8627. Ref jaraco/skeleton#18. Create Github releases when releasing the package. Fixes jaraco/skeleton#23. Moved refresh.svg to another branch. Reference the animation from the docs. Ref jaraco/skeleton#7. Add the env var mapping too. Disable pytest-black and pytest-mypy on PyPy. Fixes jaraco/skeleton#22. Ref pytest-dev/pytest#7675. Bump black and blacken-docs to latest stable versions. Use enabled plugin configuration to enable mypy and black when the plugin is present. Ref jaraco/skeleton#22. Also enable flake8 and cov when the plugins are present. Add workflows for running tests. Ref jaraco/skeleton#24. Cut releases from Github Actions instead of Azure Pipelines. Ref jaraco/skeleton#24. Refresh docs to prefer Github Actions to Azure Pipelines. Ref jaraco/skeleton#24. Use RTD v2 config Test on Python 3.9. Skip 3.7 to avoid creating too many builds. Release on 3.9. Drop tests on Travis, Appveyor, and Azure Pipelines. use add-github-secrets, which infers the secrets needed from the github workflow. Use inline flags with local scope. Honor TOX_WORK_DIR if set. Workaround for tox-dev/tox#20. Collapse skeleton history from archive/2020-12 Update skeleton description to describe the periodic collapse. Fixes #27. Enable automerge Automatically inject project name in docs heading. pre-commit autoupdate Rename 'Automated Tests' to simply 'tests' Add note about automatic merging of PRs and the requirements and limitations. Prefer pytest-enabler to jaraco.test Enable complexity limit. Fixes jaraco/skeleton#34. Add support for namespace packages. Closes jaraco/skeleton#40. Normalize indentation ⚫ Fade to black. Update changelog. Suppress test failures on Windows Use short link for issue Replace rwt with pip-run Sviatoslav Sydorenko (3): Replace pep517.build with build (#37) Use license_files instead of license_file in meta (#35) Use `extend-ignore` in flake8 config (#33) Vincent Fazio (1): setup.cfg: let python-tag mirror python_requires johnthagen (1): Line wrap LICENSE file layday (1): Require toml extra for setuptools_scm (#12)

…version 3.2.0 Jason R. Coombs (9): Automatically inject project name in docs heading. pre-commit autoupdate Rename 'Automated Tests' to simply 'tests' Add note about automatic merging of PRs and the requirements and limitations. Prefer pytest-enabler to jaraco.test Enable complexity limit. Fixes jaraco/skeleton#34. Add support for namespace packages. Closes jaraco/skeleton#40. Switch to PEP 420 namespace package Disable doctests as workaround for pytest-dev/pytest#3396. Sviatoslav Sydorenko (3): Replace pep517.build with build (#37) Use license_files instead of license_file in meta (#35) Use `extend-ignore` in flake8 config (#33)

…22.3.0 Jason R. Coombs (11): Add support for namespace packages. Closes jaraco/skeleton#40. Normalize indentation Exclude dist from discovered packages. Fixes jaraco/skeleton#46. It's no longer necessary to filter this warning and it's not a warning anymore. Bump minimum pytest In get_keyring, ensure the return type is a KeyringBackend. Restore Keyring on OS_X module along with a DeprecationWarning. Fixes #487. Ignore the warning during tests. Add types to parameters to KeyringBackend methods. 🧎‍♀️ Genuflect to the types. Update changelog. KOLANICH (1): Added an .editorconfig. Pull request jaraco/skeleton#43.

Jason R. Coombs (18): Use inline flags with local scope. Honor TOX_WORK_DIR if set. Workaround for tox-dev/tox#20. Collapse skeleton history from archive/2020-12 Update skeleton description to describe the periodic collapse. Fixes #27. Enable automerge Automatically inject project name in docs heading. pre-commit autoupdate Rename 'Automated Tests' to simply 'tests' Add note about automatic merging of PRs and the requirements and limitations. Prefer pytest-enabler to jaraco.test Enable complexity limit. Fixes jaraco/skeleton#34. Add support for namespace packages. Closes jaraco/skeleton#40. Disable 2020-resolver. Workaround for pypa/pip#9143. Normalize indentation Exclude dist from discovered packages. Fixes jaraco/skeleton#46. It's no longer necessary to filter this warning and it's not a warning anymore. Bump minimum pytest Update changelog. KOLANICH (1): Added an .editorconfig. Pull request jaraco/skeleton#43. Sviatoslav Sydorenko (3): Replace pep517.build with build (#37) Use license_files instead of license_file in meta (#35) Use `extend-ignore` in flake8 config (#33)

….0.2 Jason R. Coombs (16): Honor TOX_WORK_DIR if set. Workaround for tox-dev/tox#20. Collapse skeleton history from archive/2020-12 Update skeleton description to describe the periodic collapse. Fixes #27. Enable automerge Automatically inject project name in docs heading. pre-commit autoupdate Rename 'Automated Tests' to simply 'tests' Add note about automatic merging of PRs and the requirements and limitations. Prefer pytest-enabler to jaraco.test Enable complexity limit. Fixes jaraco/skeleton#34. Add support for namespace packages. Closes jaraco/skeleton#40. Use pytest.mark to selectively skip test. Normalize indentation Exclude dist from discovered packages. Fixes jaraco/skeleton#46. Update changelog. Revert "Use pytest.mark to selectively skip test." KOLANICH (1): Added an .editorconfig. Pull request jaraco/skeleton#43. Sviatoslav Sydorenko (3): Replace pep517.build with build (#37) Use license_files instead of license_file in meta (#35) Use `extend-ignore` in flake8 config (#33)

…on 3.5.1 Brian Rutledge (1): Use shutil for rmtree Hugo (1): Fix AppVeyor typo Hugo van Kemenade (2): Spelling and capitalisation (#8) Link badge to PyPI rather than static image Jason R. Coombs (74): Python 3 only Cover Python 3.8 in Windows tests Update black in pre-commit and add blacken-docs. Test and release using Azure Pipelines Correct guidance on project creation. Rely on setuptools_scm 3.4 and setuptools 42. Now setup.py is optional. Remove setuptools from test environment. Finish dropping support for Python 2 (I hope). Normalize whitespace Revert "setup.cfg: let python-tag mirror python_requires" Update to bionic for Travis. Correct comment about IPv6 workaround. Suppress warnings in pytest-flake8, pytest-black, and pytest-checkdocs. Prefer pytest-black to pytest-black-multipy Test against Windows and Mac Define a default pool_vm_image Remove tox-venv and tox-pip-version. Tox-venv is discouraged (tox-dev/tox-venv#48 (comment)) and tox-pip-version was only there to support tox-venv. venv is dead; long live virtualenv. Remove more references to tox-venv Add workaround for warning emitted when junitxml is used. Ref pytest-dev/pytest#6178. Include mypy for type checking during tests. Ensure virtualenv is upgraded when installing tox. Fixes jaraco/path#188. Run tests on prereleases of Python on Windows. Fixes jaraco/skeleton#17. Add workaround for python/mypy#8627. Fixes jaraco/skeleton#18. Add 'refresh.svg' demonstrating an example of refreshing a project with the latest skeleton. Ref #7. Move workaround for python/mypy#8627 to tox.ini, as adding it to setup.cfg prevents releases to PyPI. Fixes jaraco/skeleton#19. Remove workaround for python/mypy#8627. Ref jaraco/skeleton#18. Create Github releases when releasing the package. Fixes jaraco/skeleton#23. Moved refresh.svg to another branch. Reference the animation from the docs. Ref jaraco/skeleton#7. Add the env var mapping too. Disable pytest-black and pytest-mypy on PyPy. Fixes jaraco/skeleton#22. Ref pytest-dev/pytest#7675. Bump black and blacken-docs to latest stable versions. Use enabled plugin configuration to enable mypy and black when the plugin is present. Ref jaraco/skeleton#22. Also enable flake8 and cov when the plugins are present. Add workflows for running tests. Ref jaraco/skeleton#24. Cut releases from Github Actions instead of Azure Pipelines. Ref jaraco/skeleton#24. Refresh docs to prefer Github Actions to Azure Pipelines. Ref jaraco/skeleton#24. Use RTD v2 config 🧎‍♀️ Genuflect to the types. Remove compatibility code. Update changelog. Test on Python 3.9. Skip 3.7 to avoid creating too many builds. Release on 3.9. Drop tests on Travis, Appveyor, and Azure Pipelines. use add-github-secrets, which infers the secrets needed from the github workflow. Use inline flags with local scope. Honor TOX_WORK_DIR if set. Workaround for tox-dev/tox#20. Collapse skeleton history from archive/2020-12 Update skeleton description to describe the periodic collapse. Fixes #27. Enable automerge Add trim methods to WordSet 🧎‍♀️ Genuflect to the types. Automatically inject project name in docs heading. pre-commit autoupdate Rename 'Automated Tests' to simply 'tests' Add note about automatic merging of PRs and the requirements and limitations. Prefer pytest-enabler to jaraco.test Enable complexity limit. Fixes jaraco/skeleton#34. Add support for namespace packages. Closes jaraco/skeleton#40. Normalize indentation Rely on PEP 420 for namespace package Update changelog. Exclude dist from discovered packages. Fixes jaraco/skeleton#46. It's no longer necessary to filter this warning and it's not a warning anymore. Bump minimum pytest Require twine 3 with keyring unconditionally required. Add comments indicating why the exclusions are present Exclude mypy on Python 3.10 as workaround for python/typed_ast#156. Bump minimums on pytest-checkdocs and pytest-enabler as found on Setuptools. Also deny black on Python 3.10 as workaround for python/typed_ast#156. Add leading */ to coverage.run.omit. Workaround for pytest-dev/pytest-cov#456. Remove automerge. Fixes jaraco/skeleton#49. Enable dependabot (#50) Replace md file with badge linking to documentation site. Fixes jaraco/skeleton#47. Test on Python 3.10 Remove setup_requires, obviated by build-requires in pyproject.toml. Suppress deprecation warnings in flake8 and packaging.tags. Ref pypa/packaging#433. Fix syntax for in_. Closes #5. KOLANICH (1): Added an .editorconfig. Pull request jaraco/skeleton#43. Sviatoslav Sydorenko (4): Replace pep517.build with build (#37) Use license_files instead of license_file in meta (#35) Use `extend-ignore` in flake8 config (#33) Make sphinx fail on any warnings (#36) Vincent Fazio (1): setup.cfg: let python-tag mirror python_requires johnthagen (1): Line wrap LICENSE file layday (1): Require toml extra for setuptools_scm (#12)

jaraco closed this as completed in 0df4081 Jan 16, 2021

This was referenced Mar 8, 2021

Bump zipp from 3.4.0 to 3.4.1 QEDK/goodbot#130

Merged

Bump path from 15.0.1 to 15.1.2 LADI-Dataset/ladi-tutorial#94

Merged

jaraco mentioned this issue Sep 3, 2022

Simplify Chinese New Year shift workalendar/workalendar#718

Closed

jaraco added a commit to jaraco/jaraco.vcs that referenced this issue Jun 20, 2023

Add support for namespace packages. Closes jaraco/skeleton#40.

31d95bd

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for projects with namespace packages #40

Add support for projects with namespace packages #40

jaraco commented Jan 16, 2021

Add support for projects with namespace packages #40

Add support for projects with namespace packages #40

Comments

jaraco commented Jan 16, 2021