buildparser 0.1.1

BuildParser
===========

项目构建配置的[规范](SPECIFICATION.md)和解析器。

## 安装

### pip
```bash
pip install buildparser
````

### git
```bash
git clone git://github.com/brettlangdon/buildparser.git
cd ./buildparser
python setup.py install
```

## 基本用法

```python
import buildparser

builds = buildparser.parse("./path/to/project")
for build in builds
print build.env
print build.before_build
print build.build
print build.after_build
print build.after_success
print build.after_failure
```

## API

### Environment(object)
#### 属性
* `type` - 字符串
* `options` - 混合类型

#### 方法
* `__init__(self, type, options)`
* `__repr__(self)`
* `as_dict(self)`
* `as_json(self)`
* `as_yaml(self)`

### Script(object)
#### 属性
* `commands` - 列表

#### 方法
* `__init__(self, commands)`
* `__repr__(self)`
* `as_dict(self)`
* `as_json(self)`
* `as_yaml(self)`

### Build(object)
#### 属性
* `env` - Environment
* `before_build` - Script
* `build` - Script
* `after_build` - Script
* `after_success` - Script
* `after_failure` - Script

#### 方法
* `__init__(self, env, before_build, build, after_build, after_success, after_failure)`
* `__repr__(self)`
* `as_dict(self)`
* `as_json(self)`
* `as_yaml(self)`

## UnknownExtensionException(Exception)

## parse(directory, name="build")
*返回值*： 列表

在目录`directory`中查找适当的`name`文件或目录
并解析找到的所有可能的构建配置。

`parse`默认查找以下文件
* `.build.yml`
* `.build.yaml`
* `.build.json`
* `.build.ini`
* `.build.cfg`

或目录`.build`，其中包含一个或多个配置文件
(名称不必是"build").

## 解析目录(dir_name)
*返回值*： 列表

在`dir_name`内查找所有合适的文件并解析找到的配置。

## 解析文件(file_name)
*返回值*： 列表

从`file_name`解析任何可用的构建配置。

## 解析yaml(file_name)
*返回值*： 列表

将`file_name`作为yaml文件解析任何可用的构建配置。

## 解析json(file_name)
*返回值*： 列表

将`file_name`作为json文件解析任何可用的构建配置。

## 解析ini(file_name)
*返回值*： 列表

将`file_name`作为ini文件解析任何可用的构建配置。