mwdoc 0.1.0

Mwdoc
=====

概述
--------

将[mwdoc](https://pypi.python.org/pypi/mwdoc)视为一个允许轻松版本化mediawiki页面的工具。

例如，以下页面

Documentation/0.2/mypage
Template:Documentation/0.2/mytemplate

... 可以自动从

Documentation/0.1/mypage
Template:Documentation/0.1/mytemplate


安装
------------

安装`mwdoc`将自动安装所需依赖项。

```
pip install mwdoc
```

用法
-----

* 创建页面

``` python
import mwdoc
doc = mwdoc.Documentation('somewhere.org', '/w/')
doc.login('john', 'password')
doc.createPage('0.1', 'mypage', '这是我的页面内容', 'Documentation')
doc.createPage('0.1', 'mytemplate', '这是我的模板内容', 'Template:Documentation')
```


* 从0.1版本到0.2版本版本页面

``` python
import mwdoc
doc = mwdoc.Documentation('somewhere.org', '/w/')
doc.login('john', 'password')
doc.versionPages('0.1', '0.2', ['Documentation', 'Template:Documentation'])
```


* 列出页面

``` python
import mwdoc
doc = mwdoc.Documentation('somewhere.org', '/w/')
doc.login('john', 'password')
pages = doc.listPages('Documentation')
for page in pages
print(page)
templatepages = doc.listPages('Template:Documentation')
for page in templatepages
print(page)
```

* 删除页面

``` python
import mwdoc
doc = mwdoc.Documentation('somewhere.org', '/w/')
doc.login('john', 'password')
pages = doc.listPages('Documentation')
for page in pages
page.delete()
```

依赖项
------------

* [mwclient][mwclient]，[MediaWiki API][mwapi]的客户端


测试
----

**切勿**在生产安装上运行此测试。我们是认真的。

测试将创建页面，对其进行版本控制，并在之后删除它们。

要运行测试

```
git clone git://github.com/jcfr/mwdoc && cd $_
pip install -r requirements.txt
python -m unittest test_mwdoc
```

然后它会要求

* 主机名（例如 `localhost`）
* 路径（例如 `/w/`）
* 用户名
* 密码


贡献
------------

一旦你完成了你的伟大提交

1. [分支][fk] mwdoc
2. 创建一个主题分支 - `git checkout -b my_branch`
3. 推送到你的分支 - `git push origin my_branch`
4. 创建一个[问题][is]并链接到你的分支
5. 就这样！


发布新版本
------------------

核心开发者应使用以下步骤来发布 **mwdoc** 的版本。

0. 按照以下链接配置 `~/.pypirc`：[此处](https://packaging.pythonlang.cn/distributing/#uploading-your-project-to-pypi)。

1. 确保所有测试都通过。

2. 标记发布。需要带有签名的 GPG 密钥。对于版本 *X.Y.Z*：

```bash
git tag -s -m "mwdoc X.Y.Z" X.Y.Z upstream/master
```

3. 创建源 tarball 和二进制 wheels

```bash
git checkout master
git fetch upstream
git reset --hard upstream/master
rm -rf dist/
python setup.py sdist bdist_wheel
```

4. 将包上传到测试 PyPI 实例：

```bash
twine upload --sign -r pypitest dist/*
```

5. 检查 [PyPI 测试包页面](https://testpypi.python.org/pypi/mwdoc/)。

6. 将包上传到 PyPI 实例：

```bash
twine upload --sign dist/*
```

7. 检查 [PyPI 包页面](https://pypi.python.org/pypi/mwdoc/)。

8. 确保包可以被安装：

```bash
mkvirtualenv test-pip-install
pip install mwdoc
rmvirtualenv test-pip-install
```

致谢
-------

请参阅 GitHub 项目页面：https://github.com/jcfr/mwdoc/graphs/contributors

元数据
----

* PyPI: <https://pypi.python.org/pypi/mwdoc>
* 代码: `git clone git://github.com/jcfr/mwdoc.git`
* 主页: <http://github.com/jcfr/mwdoc#readme>
* 缺陷: <http://github.com/jcfr/mwdoc/issues>

许可
-------

根据 Apache 许可证 2.0 版（“许可证”）；
除非您遵守许可证，否则不得使用此文件。
您可以在以下位置获得许可证副本：

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或书面同意，否则根据许可证分发的软件
是在“现状”基础上分发的，
不提供任何明示或暗示的保证。
有关许可权限和
限制的特定语言，请参阅许可证。

[fk]: http://help.github.com/forking/
[is]: http://github.com/jcfr/mwdoc/issues
[mwclient]: http://sourceforge.net/apps/mediawiki/mwclient
[mwapi]: https://www.mediawiki.org/wiki/API