emanual

EManual-CLI
-----------
[![PyPI version](https://badge.fury.io/py/emanual.svg)](http://badge.fury.io/py/emanual)
[![Downloads](https://pypip.in/download/emanual/badge.png)](https://pypi.python.org/pypi/emanual/)

Command Line Interface for EManual

install
-------
```shell
$ pip install emanual
```

Usage
-----

## 语言资料模块

0. 初始化模块
```shell
$ emanual init {module name}
```

1. 创建`info.json` & 把中文文件名变为拼音
```shell
$ cd path/to/md-xxx
$ emanual create {lang}
// `./dist/{lang}`就是生成的内容
````

2. 生成lang.zip
```shell
$ emanual dist {lang} //lang为指定的语言，小写
```

## NewsFeeds模块

1. 更新
```shell
$ emanual newsfeeds update
```

## 文件名处理

```shell
cd path/to/md-xxx/markdown //通常修改这目录
emanual filename check [path=.] //检查路径目录(默认是当前)下的文件名是否存在中文字符的标点
emanual filename fix [path=.] //修复存在中文标点的

```

Development
-----------

#### 1. 使用virtualenv,未安装则`pip install virtualenv`
```shell
//创建虚拟的python开发环境
$ virtualenv env

//开启
$ source env/bin/activate

//退出
$ deactivate
```

#### 2. 安装依赖
```
$ pip install -r requirements-dev.txt
```

#### 3. 动态加载当前库
```shell
$ cd path/to/EManual-CLI
$ pip install --edit .
//or
$ pip install -e .
```

#### 4. 安装测试
```shell
$ python setup.py install
$ emanual --version
```

dependency
--

- 命令行创建工具[click](https://github.com/mitsuhiko/click)
- 路径解释[path.py](https://github.com/jaraco/path.py)
- 中文转拼音[pypinyin](https://github.com/smallqiao/pypinyin)
- markdown渲染[mistune](https://github.com/lepture/mistune)
- DOM操作[beautifulsoup4](http://www.crummy.com/software/BeautifulSoup/)

License
-------

MIT

Metadata

Release files for emanual 0.4.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for emanual 0.4.4
File	Size	Uploaded
emanual-0.4.4.tar.gz	6.3 kB	Jan 16, 2016	Details

Release files / emanual-0.4.4.tar.gz

Download URL	emanual-0.4.4.tar.gz
Size	6.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`e4734c953a0ba0a48a9fcbd7d4378b678aa8e43258a864fe50eceab557dec94a`
BLAKE2b-256 checksum How to use checksums	`6c462032101f746eb6a7f21770eccbbf2407eaa014d44aafe7468682c1ec2bf4`
Upload date	Jan 16, 2016
Uploaded using Trusted Publishing? What is trusted publishing?	No