允许轻松版本mediawiki页面。
mwdoc的Python项目详细描述
mwdoc
=
概述
——
可以从以下位置自动创建:
documentation/0.1/mypage
template:documentation/0.1/mytemplate
----
installing`mwdoc`将自动安装所需的依赖项。
`````
pip install mwdoc
`````
us年龄
----
*创建页面:
``python
import mwdoc
doc=mwdoc.documentation('somewhere.org','/w/')
doc.login('john','password')
doc.create page('0.1','mypage','this is content of my page','documentation')
doc createpage('0.1','mytemplate','this is con"我的模板的内容","模板:文档")
```
*版本页从0.1到0.2:
``python
import mwdoc
doc=mwdoc.documentation('somewhere.org','/w/')
doc.login('john','password')
doc.version pages('0.1','0.2',['documentation','模板:文档ation'])
```
*列表页:
``python
导入mwdoc
doc=mwdoc.documentation('somewhere.org','/w/')
doc.login('john','password')
页=doc.list pages('documentation')
页中页:
打印(页)
模板页=doc.listpages('template:documentation')
对于模板页中的页面:
打印(页面)
````
*删除页面:
```python
导入mwdoc
doc=mwdoc.documentation('somewhere.org','/w/')
doc.login('john','password')
页面=doc.listpages('documentation')
对于页面中的页面:
page.delete()
````
依赖项
----
*[mwclient][mwclient],客户端到[mediawiki api][mwapi]
----
不要**对生产安装运行此测试。我们是认真的。
测试将创建页面、版本并在之后删除它们。
/>
*主机名(例如"localhost")
*路径(例如`/w/`)
*用户名
*密码
[fork][fk]mwdoc
2.创建主题分支-"git checkout-b my_branch"
3。推到你的分支-`git push origin my_branch`
4.创建一个[issue][is]并链接到您的分支
5。就是这样!
创建新版本
----
核心开发人员应使用以下步骤创建**mwdoc**.
0的版本。按[此处]所述配置`~/.pypirc'(https://packaging.python.org/distributing/将项目上载到pypi)。
1.确保所有测试都通过。
2.标记释放。需要带签名的GPG密钥。对于版本*x.y.z*:
`` bash
git tag-s-m"mwdoc x.y.z"x.y.z upstream/master
```
>3。创建源tarball和二进制轮:
``` bash
git checkout master
git fetch upstream
git reset--hard upstream/master
rm-rf dist/
python setup.py sdist bdist\u wheel
```
4。将包上载到测试pypi实例::
```bash
tween upload--sign-r pypitest dist/*
```
>5。查看[PYPI测试包页面](https://testpypi.python.org/pypi/mwdoc/)。
6。将包上载到pypi实例::
``bash
tween upload--sign dist/*
```
>7。查看[PYPI包页面](https://pypi.python.org/pypi/mwdoc/)。
8。确保包可以安装::
`` bash
mkvirtualenv test pip install
pip install mwdoc
rmvirtualenv test pip install
```
credits
----
请参阅github项目页面,网址为https://github.com/jcfr/mwdoc/graphs/contributors
meta
----
*pypi:<;https://pypi.python.org/pypi/mwdoc>;
*代码:`git clone git://github.com/jcfr/mwdoc.git`
*home:<;http://github.com/jcfr/mwdoc readme>;
*错误:<;http://github.com/jcfr/mwdoc/issues>;
许可证
----
根据apache许可证2.0版("许可证")获得许可证;
除非符合许可证,否则您不能使用此文件。
在http://www.apache.org/licenses/license-2.0
r/>请参阅许可证以了解控制许可的特定语言以及许可证下的限制。
[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
=
概述
——
可以从以下位置自动创建:
documentation/0.1/mypage
template:documentation/0.1/mytemplate
----
installing`mwdoc`将自动安装所需的依赖项。
`````
pip install mwdoc
`````
us年龄
----
*创建页面:
``python
import mwdoc
doc=mwdoc.documentation('somewhere.org','/w/')
doc.login('john','password')
doc.create page('0.1','mypage','this is content of my page','documentation')
doc createpage('0.1','mytemplate','this is con"我的模板的内容","模板:文档")
```
*版本页从0.1到0.2:
``python
import mwdoc
doc=mwdoc.documentation('somewhere.org','/w/')
doc.login('john','password')
doc.version pages('0.1','0.2',['documentation','模板:文档ation'])
```
*列表页:
``python
导入mwdoc
doc=mwdoc.documentation('somewhere.org','/w/')
doc.login('john','password')
页=doc.list pages('documentation')
页中页:
打印(页)
模板页=doc.listpages('template:documentation')
对于模板页中的页面:
打印(页面)
````
*删除页面:
```python
导入mwdoc
doc=mwdoc.documentation('somewhere.org','/w/')
doc.login('john','password')
页面=doc.listpages('documentation')
对于页面中的页面:
page.delete()
````
依赖项
----
*[mwclient][mwclient],客户端到[mediawiki api][mwapi]
不要**对生产安装运行此测试。我们是认真的。
测试将创建页面、版本并在之后删除它们。
/>
*主机名(例如"localhost")
*路径(例如`/w/`)
*用户名
*密码
[fork][fk]mwdoc
2.创建主题分支-"git checkout-b my_branch"
3。推到你的分支-`git push origin my_branch`
4.创建一个[issue][is]并链接到您的分支
5。就是这样!
创建新版本
----
核心开发人员应使用以下步骤创建**mwdoc**.
0的版本。按[此处]所述配置`~/.pypirc'(https://packaging.python.org/distributing/将项目上载到pypi)。
1.确保所有测试都通过。
2.标记释放。需要带签名的GPG密钥。对于版本*x.y.z*:
`` bash
git tag-s-m"mwdoc x.y.z"x.y.z upstream/master
```
>3。创建源tarball和二进制轮:
``` bash
git checkout master
git fetch upstream
git reset--hard upstream/master
rm-rf dist/
python setup.py sdist bdist\u wheel
```
4。将包上载到测试pypi实例::
```bash
tween upload--sign-r pypitest dist/*
```
>5。查看[PYPI测试包页面](https://testpypi.python.org/pypi/mwdoc/)。
6。将包上载到pypi实例::
``bash
tween upload--sign dist/*
```
>7。查看[PYPI包页面](https://pypi.python.org/pypi/mwdoc/)。
8。确保包可以安装::
`` bash
mkvirtualenv test pip install
pip install mwdoc
rmvirtualenv test pip install
```
credits
----
请参阅github项目页面,网址为https://github.com/jcfr/mwdoc/graphs/contributors
meta
----
*pypi:<;https://pypi.python.org/pypi/mwdoc>;
*代码:`git clone git://github.com/jcfr/mwdoc.git`
*home:<;http://github.com/jcfr/mwdoc readme>;
*错误:<;http://github.com/jcfr/mwdoc/issues>;
许可证
----
根据apache许可证2.0版("许可证")获得许可证;
除非符合许可证,否则您不能使用此文件。
在http://www.apache.org/licenses/license-2.0
r/>请参阅许可证以了解控制许可的特定语言以及许可证下的限制。
[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