气候影响实验室工作的求职者
jrnr的Python项目详细描述
====
jrnr
====
…图片::https://img.shields.io/pypi/v/jrnr.svg
:目标:https://pypi.python.org/pypi/jrnr
…图片::https://img.shields.io/travis/climateimpactlab/jrnr.svg
:目标:https://travis ci.org/climateimpactlab/jrnr
…图片::https://readthedocs.org/projects/jrnr/badge/?version=latest
:目标:https://jrnr.readthedocs.io/en/latest/?徽章=最新
:alt:文档状态
…图片::https://pyup.io/repos/github/climateampactlab/jrnr/shield.svg
:目标:https://pyup.io/repos/github/climateampactlab/jrnr/
:alt:updates
https://jrnr.readthedocs.io.
设置此包
<--
自述文件中删除此部分。*
1。如果您还没有在github上创建匹配的存储库:
a.转到https://github.com/organizations/climateimpactlab/repositories/new
b.输入以下信息:
climateimpactlab
repository name
JNR
说明
气候影响实验室作业的作业管理器
隐私
公共
**不要使用自述文件、许可证或gitignore初始化repo!**
c.按绿色大按钮
2.在此目录中执行以下命令:
…代码块::bash
git init
git add.
git commit-m"initial commit"
git remote add origin git@github.com:climateimpactlab/jrnr.git
git push-u origin master
3.设置自动测试、覆盖、更新,以及文档:
a.设置测试
i.转到https://travis-ci.org/并登录/注册GitHub。
通过启用
,确保Travis可以访问GitHub上的存储库
帐户*和ClimateImpactLab拥有的存储库。访问您的帐户设置。
ii.在"My Repositories"旁边,单击"+"图标
iii。打开ClimateImpactLab/JNR。如果在列表中看不到它,请单击"同步帐户",并确保正在查看ClimateImpactLab存储库。
iv.对包进行更改(例如,可以删除此部分)。您应该会看到测试在travis上自动开始运行。
v.开始在
``jrnr/tests``文件夹中为代码编写测试。已经有一些
示例可以帮助您入门。
>b.设置文档
相同的交易-确保readthedocs可以访问您的github
账户和气候账户。单击"导入项目",转到ClimateImpactLab并刷新。
iii.单击
ClimateImpactLab/JNR旁边的"+"图标。为您的
项目选择一个名称。该名称必须是全局唯一的(不只是在
ClimateImpactLab中),因此如果您选择了一个通用的
名称,则可能需要重命名文档。
iv.下次将代码推送到Master时,文档应自动生成
。您可以在
https://jrnr.readthedocs.io/en/latest/
(替换您选择的任何名称)。
c.设置更新
我知道。转到你的帐户,然后单击"+添加回购"。同步。
iii.添加climateimpactlab/jrnr
并打开"依赖项更新"和"安全性"。关闭"更新计划"。
d.设置测试覆盖率监控
e.放松呼吸。下一次您推送代码时,这些都应该为
您更新!那还不算太糟吧?
4.使用github开发:
a.通常,当您想要更改某个内容或发现错误时,最好提交一个问题,然后编写测试来预先测试关于所需行为的断言,然后编写通过这些测试所需的最少
代码。有关更多
工作流建议,请参阅相关文档。
要在本地计算机上运行所有测试:
…代码块:bash
make test
>5。部署
a.通过在python包索引上注册包来设置部署
(pypi):
ii.注册包:
…代码块::bash
…代码块::bash
python travis_pypi_setup.py
…代码块::bash
bumpversion patch(或minor或major)
git push
git push--tags
Travis将为您部署
代码块::bash
features
-------
*todo
credits
--
此软件包是使用cookiecutter和"audreyr/cookiecutter pypackage"项目模板创建的。
_ Cookiecutter:https://github.com/audreyr/Cookiecutter
。_` audreyr/cookiecutter-pypackage`:https://github.com/audreyr/cookiecutter-pypackage
==
=
=
==history
==
<0.2.1(当前版本)
=-
*修复"slurm\u runner.do\u job"中的错误,该错误在比赛条件打开时导致作业重复发生锁对象创建(:issue:`3`)
*从"slurm\u runner"中传递的函数推断文件路径。不需要在"slurm_runner"函数调用中提供filepath参数(:issue:`5`)
*将"return_index"参数添加到"slurm_runner"`(:issue:`7`)
0.2.0(2017-07-31)
----
*修复交互式错误--call interactive=true on`` slurm戋runner.run戋interactive()```(:issue:`1`)
*添加slurm戋runner作为模块级导入
<0.1.2(2017-07-28)
----
<0.1.0(2017-07-28)
----
*在PYPI上首次发布。
jrnr
====
…图片::https://img.shields.io/pypi/v/jrnr.svg
:目标:https://pypi.python.org/pypi/jrnr
…图片::https://img.shields.io/travis/climateimpactlab/jrnr.svg
:目标:https://travis ci.org/climateimpactlab/jrnr
…图片::https://readthedocs.org/projects/jrnr/badge/?version=latest
:目标:https://jrnr.readthedocs.io/en/latest/?徽章=最新
:alt:文档状态
…图片::https://pyup.io/repos/github/climateampactlab/jrnr/shield.svg
:目标:https://pyup.io/repos/github/climateampactlab/jrnr/
:alt:updates
https://jrnr.readthedocs.io.
设置此包
<--
1。如果您还没有在github上创建匹配的存储库:
a.转到https://github.com/organizations/climateimpactlab/repositories/new
b.输入以下信息:
repository name
JNR
说明
气候影响实验室作业的作业管理器
隐私
公共
**不要使用自述文件、许可证或gitignore初始化repo!**
c.按绿色大按钮
2.在此目录中执行以下命令:
…代码块::bash
git init
git add.
git commit-m"initial commit"
git remote add origin git@github.com:climateimpactlab/jrnr.git
git push-u origin master
3.设置自动测试、覆盖、更新,以及文档:
a.设置测试
i.转到https://travis-ci.org/并登录/注册GitHub。
通过启用
,确保Travis可以访问GitHub上的存储库
帐户*和ClimateImpactLab拥有的存储库。访问您的帐户设置。
ii.在"My Repositories"旁边,单击"+"图标
iii。打开ClimateImpactLab/JNR。如果在列表中看不到它,请单击"同步帐户",并确保正在查看ClimateImpactLab存储库。
iv.对包进行更改(例如,可以删除此部分)。您应该会看到测试在travis上自动开始运行。
v.开始在
``jrnr/tests``文件夹中为代码编写测试。已经有一些
示例可以帮助您入门。
>b.设置文档
账户和气候账户。单击"导入项目",转到ClimateImpactLab并刷新。
iii.单击
ClimateImpactLab/JNR旁边的"+"图标。为您的
项目选择一个名称。该名称必须是全局唯一的(不只是在
ClimateImpactLab中),因此如果您选择了一个通用的
名称,则可能需要重命名文档。
iv.下次将代码推送到Master时,文档应自动生成
。您可以在
https://jrnr.readthedocs.io/en/latest/
(替换您选择的任何名称)。
c.设置更新
iii.添加climateimpactlab/jrnr
并打开"依赖项更新"和"安全性"。关闭"更新计划"。
d.设置测试覆盖率监控
e.放松呼吸。下一次您推送代码时,这些都应该为
您更新!那还不算太糟吧?
4.使用github开发:
a.通常,当您想要更改某个内容或发现错误时,最好提交一个问题,然后编写测试来预先测试关于所需行为的断言,然后编写通过这些测试所需的最少
代码。有关更多
工作流建议,请参阅相关文档。
要在本地计算机上运行所有测试:
…代码块:bash
make test
>5。部署
a.通过在python包索引上注册包来设置部署
(pypi):
…代码块::bash
…代码块::bash
python travis_pypi_setup.py
…代码块::bash
bumpversion patch(或minor或major)
git push
git push--tags
Travis将为您部署
代码块::bash
features
-------
*todo
credits
--
此软件包是使用cookiecutter和"audreyr/cookiecutter pypackage"项目模板创建的。
_ Cookiecutter:https://github.com/audreyr/Cookiecutter
。_` audreyr/cookiecutter-pypackage`:https://github.com/audreyr/cookiecutter-pypackage
==
=
=
==history
==
<0.2.1(当前版本)
=-
*修复"slurm\u runner.do\u job"中的错误,该错误在比赛条件打开时导致作业重复发生锁对象创建(:issue:`3`)
*从"slurm\u runner"中传递的函数推断文件路径。不需要在"slurm_runner"函数调用中提供filepath参数(:issue:`5`)
*将"return_index"参数添加到"slurm_runner"`(:issue:`7`)
0.2.0(2017-07-31)
----
*修复交互式错误--call interactive=true on`` slurm戋runner.run戋interactive()```(:issue:`1`)
*添加slurm戋runner作为模块级导入
<0.1.2(2017-07-28)
----
<0.1.0(2017-07-28)
----
*在PYPI上首次发布。