你好!
hola_mundo的Python项目详细描述
===========
霍拉蒙多
===========
项目目的
================
这个项目演示了如何实际获得一个开源python项目
开源。这意味着:
-获取源代码管理。
-获取开发环境。
-获得测试和覆盖率。
-获取文档。
-发布到pypi。
-发布文档。
如果你想直截了当地解释一下*
配置可以作为获取开源pypi项目的示例,然后
生成帮助文档,它将指导您了解
让hola mundo*成为开源产品的方法。
接下来的是*hola mundo*应用程序!
分享和享受
=================
霍尔蒙多0.0.3
=================
hola munda用法
=================
*hola mundo*使您的问候语更容易国际化。
执行*hola mundo*可以通过以下方式完成:
>;Python-m hola_mundo.main<;索引>;
或
>;python hola_mundo/main.py<;索引>;
:index:一个可选整数,将在给定的
语言。如果没有提供,那么“hola mundo”的随机版本将
提供。
文档
-----
有关最新文档,请访问http://neoinsanity.github.io/hola_mundo/
====================
项目开发
====================
如果您有兴趣开发**hola mundo**代码,请使用帮助程序
位于*hola_mundo/bin*目录中的脚本。只需按照下面的说明操作
用于设置
首先获取源!
可在
请访问https://github.com/neoinsity/hola_mundo。
运行dev environment安装程序
--------
在运行dev安装脚本之前:
1.确保安装了*python3*。可以使用命令进行检查:
Python3——版本
2.确保已安装*virtualenv*。您可以使用
命令:
virtualenv—版本
请记住,要执行的所有脚本都假定来自
项目“根”目录。这是带有*setup.py*文件的目录。
一旦您排除了先决条件,我们就可以运行开发
配置脚本。
使用以下命令准备开发环境:
>;bin/dev_设置.sh
此命令将为目录中的项目设置virtualenv
*/venv*。它还将以开发模式安装**hola mundo**,并使用
创建开发egg文件。
开发环境的使用
==================================
本节将演示
资源开发。这个特性支持开发环境,执行
使用覆盖率进行单元测试,并生成文档。
启用开发环境
-
此命令必须在每个开发人员会话开始时执行。它
将确保开发工具可用,并且
环境处于活动状态。
命令如下所示,请注意,它源于设置virtualenv:
>;。bin/启用dev.sh
或
>;源bin/启用dev.sh
启用开发环境会将*bin*目录脚本添加到环境中
*路径*。这允许下面的命令在
项目<;根>;。
运行测试和代码覆盖率
--
要运行单元测试:
>;运行测试.sh
要查看代码覆盖率报告,请打开文件
`root`/build/converage_report/index.html。
建筑文件
-
要运行文档生成:
>;文档生成.sh
要查看文档,请打开文件“root`/build/doc/index.html。
霍拉蒙多
===========
项目目的
================
这个项目演示了如何实际获得一个开源python项目
开源。这意味着:
-获取源代码管理。
-获取开发环境。
-获得测试和覆盖率。
-获取文档。
-发布到pypi。
-发布文档。
如果你想直截了当地解释一下*
配置可以作为获取开源pypi项目的示例,然后
生成帮助文档,它将指导您了解
让hola mundo*成为开源产品的方法。
接下来的是*hola mundo*应用程序!
分享和享受
=================
霍尔蒙多0.0.3
=================
hola munda用法
=================
*hola mundo*使您的问候语更容易国际化。
执行*hola mundo*可以通过以下方式完成:
>;Python-m hola_mundo.main<;索引>;
或
>;python hola_mundo/main.py<;索引>;
:index:一个可选整数,将在给定的
语言。如果没有提供,那么“hola mundo”的随机版本将
提供。
文档
-----
有关最新文档,请访问http://neoinsanity.github.io/hola_mundo/
====================
项目开发
====================
如果您有兴趣开发**hola mundo**代码,请使用帮助程序
位于*hola_mundo/bin*目录中的脚本。只需按照下面的说明操作
用于设置
首先获取源!
可在
请访问https://github.com/neoinsity/hola_mundo。
运行dev environment安装程序
--------
在运行dev安装脚本之前:
1.确保安装了*python3*。可以使用命令进行检查:
Python3——版本
2.确保已安装*virtualenv*。您可以使用
命令:
virtualenv—版本
请记住,要执行的所有脚本都假定来自
项目“根”目录。这是带有*setup.py*文件的目录。
一旦您排除了先决条件,我们就可以运行开发
配置脚本。
使用以下命令准备开发环境:
>;bin/dev_设置.sh
此命令将为目录中的项目设置virtualenv
*/venv*。它还将以开发模式安装**hola mundo**,并使用
创建开发egg文件。
开发环境的使用
==================================
本节将演示
资源开发。这个特性支持开发环境,执行
使用覆盖率进行单元测试,并生成文档。
启用开发环境
-
此命令必须在每个开发人员会话开始时执行。它
将确保开发工具可用,并且
环境处于活动状态。
命令如下所示,请注意,它源于设置virtualenv:
>;。bin/启用dev.sh
或
>;源bin/启用dev.sh
启用开发环境会将*bin*目录脚本添加到环境中
*路径*。这允许下面的命令在
项目<;根>;。
运行测试和代码覆盖率
--
要运行单元测试:
>;运行测试.sh
要查看代码覆盖率报告,请打开文件
`root`/build/converage_report/index.html。
建筑文件
-
要运行文档生成:
>;文档生成.sh
要查看文档,请打开文件“root`/build/doc/index.html。