Package Discovery

Package discovery based on Setuptools.

Advantage

1. Debug packages that Setuptools discovered
2. Easy to filter packages to root packages only

1. Debug packages that Setuptools discovered

You can check the discovered packages by running the following Python code.

print_packages.py:

from packagediscovery import Setuptools

print(Setuptools().packages)

$ python print_packages.py
['packagediscovery']

Since Package Discovery settings of Setuptools is a bit complicated so that we may want to know what packages Setuptools are discovering now.

cf. Package Discovery and Namespace Packages - setuptools documentation

2. Easy to filter packages to root packages only

You can filter the discovered packages to only include root packages by using the root_packages property.

filter_packages.py:

from packagediscovery import Packages, Setuptools

setuptools = Setuptools()
print(f"Packages = {setuptools.packages}")
print(f"Root packages = {Packages(setuptools.packages).list_roots_only}")

$ python filter_packages.py
Packages = ['pyvelocity', 'pyvelocity.checks', 'pyvelocity.configurations', 'pyvelocity.configurations.files', 'pyvelocity.configurations.files.sections', 'pyvelocity.configurations.files.sections.pylint', 'pyvelocity.configurations.tools', 'pyvelocity.configurations.files.sections.pylint', 'pyvelocity.configurations.files.sections', 'pyvelocity.configurations.files', 'pyvelocity.checks', 'pyvelocity.configurations.tools', 'pyvelocity.configurations']
Root packages = ['pyvelocity']

Quickstart

Install the package

$ pip install packagediscovery

How do I...

Discover packages

from packagediscovery import Setuptools

setuptools = Setuptools()
print(f"Packages = {setuptools.packages}")

Discover py modules

from packagediscovery import Setuptools

setuptools = Setuptools()
print(f"Py modules = {setuptools.py_modules}")

Discover project root

from packagediscovery import Setuptools

setuptools = Setuptools()
print(f"Project root = {setuptools.project_root}")

Filter packages to root packages only

from packagediscovery import Packages, Setuptools

setuptools = Setuptools()
print(f"Packages = {setuptools.packages}")
print(f"Root packages = {Packages(setuptools.packages).list_roots_only}")

Credits

This package was created with Cookiecutter and the yukihiko-shinoda/cookiecutter-pypackage project template.