Skip to main content

A Python plugin loader that will search for classes based from a list ofmodules and optionally use the file system to recurse into packages.

Project description

pyscovery is a Python plugin loader that will search for classes based from a
list of modules and optionally use the file system to recurse into packages.

This is different from pkg_resources and friends since it doesn't require you
to add every module that might have packages, it will discover it for you.

I wrote this because none of the existing solutions fit my need of being able
to logically group similar plugins in the filesystem.

Say you have the following structure in your project:

module/
__init__.py
plugin.py
plugins/
__init__.py
plugin1/
__init__.py
plugin2/
__init__.py
plugin3.py

With pyscovery, the following code will find plugins 1, 2, and 3 for you:

import pyscovery

from plugin import Plugin

pyscovery.add_module('plugins')
for plugin in pyscovery.find(Plugin, True, False):
print plugin

Recursion in the filesystem is off by default, since that's the way people are
used to. If there is enough demand, I will make it the default.

If you want to create instances of all the classes found instead of just
getting the class it self, you can use the following:

for plugin in pyscovery.find(Plugin, True, True):
print plugin

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyscovery-1.2.tar.gz (3.5 kB view details)

Uploaded Source

File details

Details for the file pyscovery-1.2.tar.gz.

File metadata

  • Download URL: pyscovery-1.2.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pyscovery-1.2.tar.gz
Algorithm Hash digest
SHA256 14362aa054b51e6af87436418f13dd5acb4e077b89e1b11630c984682cfcd312
MD5 090c30726367ea99838d9eca7fcb6dde
BLAKE2b-256 99e4188c9394482466d7efb4de71897b6f00a3d52813e3be94ff4b8ddddcb8bc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page