Home | Trees | Index | Help |
|
---|
|
object --+ | Cheesecake
Computes 'goodness' of Python packages.
Generates "cheesecake index" that takes into account things like:
- whether the package can be downloaded
- whether the package can be unpacked
- whether the package can be installed into an alternate directory
- existence of certain files such as README, INSTALL, LICENSE, setup.py etc.
- existence of certain directories such as doc, test, demo, examples
- percentage of modules/functions/classes/methods with docstrings
- percentage of functions/methods that are unit tested
- average pylint score for all non-test and non-demo modules
|
|||
__init__(self,
name="",
url="",
path="",
sandbox=None,
logfile=None,
verbose=False,
quiet=False,
static_only=False,
lite=False,
keep_log=False)
Initialize critical variables, download and unpack package, walk package tree. |
|||
raise_exception(self,
msg)
Cleanup, print error message and raise CheesecakeError. |
|||
cleanup(self,
remove_log_file=True)
Delete temporary directories and files that were created in the sandbox. |
|||
configure_logging(self,
logfile=None)
Default settings for logging. |
|||
run_step(self,
step_name)
Run step if its decide() method returns True. |
|||
get_pkg_from_pypi(self)
Download package using setuptools utilities. |
|||
download_pkg(self)
Use urllib.urlretrieve to download package to file in sandbox dir. |
|||
copy_pkg(self)
Copy package file to sandbox directory. |
|||
unpack_pkg(self)
Unpack the package in the sandbox directory. |
|||
walk_pkg(self)
Get package files and directories. |
|||
install_pkg(self)
Verify that package can be installed in alternate directory. |
|||
compute_cheesecake_index(self)
Compute overall Cheesecake index for the package by adding up specific indexes. |
|||
Inherited from |
|
|||
steps | |||
package_types | |||
Inherited from |
|
|
Cleanup, print error message and raise CheesecakeError. Don't use logging, since it can be called before logging has been setup. |
|
Default settings for logging. If verbose, log goes to console, else it goes to logfile. log.debug and log.info goes to logfile. log.warn and log.error go to both logfile and stdout. |
|
Download package using setuptools utilities.
|
|
|
Unpack the package in the sandbox directory. Check package_types attribute for list of currently supported archive types.
|
Get package files and directories.
|
Verify that package can be installed in alternate directory.
|
|
|
steps
|
package_types
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 3.0alpha2 on Sat Aug 12 02:53:38 2006 | http://epydoc.sf.net |