From ea2d5502efe712cacc343e0afd245060aa19dac8 Mon Sep 17 00:00:00 2001 From: Athos Ribeiro Date: Jun 09 2017 18:28:54 +0000 Subject: Improve package documentation --- diff --git a/kiskadee/__init__.py b/kiskadee/__init__.py index 3b1f35a..5dab46b 100644 --- a/kiskadee/__init__.py +++ b/kiskadee/__init__.py @@ -4,10 +4,23 @@ kiskadee runs different static analyzers on a set of pre-defined software repositories. When the kiskadee package is loaded, we load all the plugin names in the plugins subpackages. -On the following variables and a functions are exported: +The following variables and functions are exported: - kiskadee_plugins_list - a list of all enabled plugin names - load_plugins() - a function to load all enabled plugins - config - a ConfigParser object with kiskadee configurations + +Modules: + - analyzers + - converter + - database + - helpers + - model + - monitor + - queue + - runner + +Subpackages: + plugins """ import os import importlib