Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (
Help us improve Python packaging - Donate today!

A plugin-based microframework for highly reusable applications and their components

Project Description

groundwork is a python based microframework for highly reusable applications and their components.

It’s functionality is based on exchangeable, documented and tested plugins and patterns.

It is designed to support any kind of application: command line scripts, desktop programs or web applications.

groundwork enables applications to activate and deactivate plugins during runtime and to control dynamic plugin behaviors like plugin status, used signals, registered commands and much more.

The functionality of plugins can be easily extended by the usage of inheritable patterns. Based on this, groundwork supports developers with time-saving solutions for:

  • Command line interfaces
  • Loose inter-plugin communication via signals and receivers
  • Shared objects to provide and request content to and from other plugins
  • Static and dynamic documents for an overall documentation


The following code defines a plugin with command line support and creates a groundwork application, which activates this plugin:

from groundwork import App
from groundwork.patterns import GwCommandsPattern

class MyPlugin(GwCommandsPattern):
    def _init_(self, *args, **kwargs): = "My Plugin"
        super().__init__(*args, **kwargs)

    def activate(self):
                               description='prints "hello world"',

    def greetings(self):
        print("Hello world")

if __name__ == "__main__":
    my_app = App(plugins=[MyPlugin])        # Creates app and registers MyPlugin
    my_app.plugins.activate(["My Plugin"])  # Initialise and activates 'My Plugin'
    my_app.commands.start_cli()             # Starts the command line interface

On a command line the following commands can be used now:

python hello      # Prints 'Hello world'
python            # Prints a list of available commands
python my_app.yp hello -h   # Prints some help text for the command hello
Release History

Release History

This version
History Node


Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
groundwork-0.1.1a1.tar.gz (18.8 kB) Copy SHA256 Checksum SHA256 Source Jul 29, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting