Skip to main content

Hairball is a plugin-able framework useful for static analysis of Scratch projects.

Project description

# Hairball

Hairball is a plugin-able framework useful for static analysis of Scratch projects.

The paper and presentation slides for Hairball can be found at: http://cs.ucsb.edu/~bboe/p/cv#sigcse13

A Hairball demo web service is running and available at: http://hairball.herokuapp.com


## Hairball installation

With a proper python environment (one which has `pip` available), installation is as simple as `pip install hairball`. `easy_install` can also be used via `easy_install hairball`.

To install from source, first checkout this project and then navigate your
command-line interface to the outer hairball directory that contains `setup.py`. Then run `python setup.py install`.

## Running Hairball

Once installed, to see how to use hairball run `hairball --help`. That will produce output similar to the following:

```
Usage: hairball -p PLUGIN_NAME [options] PATH...

PATH can be either the path to a scratch file, or a directory containing
scratch files. Multiple PATH arguments can be provided.

Options:
--version show program's version number and exit
-h, --help show this help message and exit
-d DIR, --plugin-dir=DIR
Specify the path to a directory containing plugins.
Plugins in this directory take precedence over
similarly named plugins included with Hairball.
-p PLUGIN, --plugin=PLUGIN
Use the named plugin to perform analysis. This option
can be provided multiple times.
```

## Available Plugins

Below are a list of available plugins that can be used as the `-p PLUGIN_NAME` option:

* blocks.BlockCounts
* blocks.DeadCode
* checks.Animation (not fully tested)
* checks.BroadcastReceive
* checks.SaySoundSync (not fully tested)
* initialization.AttributeInitialization
* initialization.VariableInitialization (not fully tested)

Note: The output for each plugin is not yet completely standardized. Please
feel free to file any issues or make improvements and send pull requests.

Project details


Release history Release notifications

History Node

0.3

History Node

0.3rc1

History Node

0.2

This version
History Node

0.1rc3

History Node

0.1rc2

History Node

0.1rc1

History Node

0.1rc0

History Node

0.1b

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
hairball-0.1rc3.tar.gz (10.8 kB) Copy SHA256 hash SHA256 Source None Sep 4, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page