检查文件是否有正确的版权标题。
copycheck的Python项目详细描述
copycheck
==
2016年janus fris nielsen版权所有。
此文件是*copycheck*
图片::https://circleci.com/gh/janudn/copycheck/tree/master.svg?style=shield&circle token=4112427381753afc2f073a61fba23263d1f86d13
:target:https://circleci.com/gh/janudn/copycheck/tree/master
introduction
----
*copycheck*检查所有文件的开头报告没有版权的任何文件
头。
版权标题的识别是非常初级的。*copycheck*扫描
10行的第一行,查看是否有"版权"一词出现在任何框中。
代码块::bash
$pip install copycheck
*copycheck*也可以从源代码安装:
…代码块::bash
$python setup.py install
…_` pypi`:http://pypi.python.org/pypi/copycheck
。_` setuptools`:https://pypi.python.org/pypi/setuptools
用法
----
如果给定
`--help`选项:
代码块::bash
$copycheck--help
用法:copycheck[-h][-v][--debug debug]{check}…
缺少版权标题
可选参数:
-h,--help显示此帮助消息并退出
-v,--verbose enable verbose output
--调试启用调试输出
检查当前目录中的所有文件
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
……代码块::bash
$copycheck check。
检查目录中的所有文件代码块::bash
$copycheck check path/to/directory
代码块::bash
$copycheck-path/to/directory-path/to/another/directory/and/so/on/。
ignore-files
~~~~~~~~~~
野生匹配。与在.gitignore中使用的相同。
代码块::bash
$copycheck check path/to/directory_sort
add copyright header
~~~~~~~~~~~~~~~~~~~~~~~
add copyright header to all python files available from current directory"
"…代码块::bash
$copycheck check。| Sort grep"\.py"xargs-l1 sed-i'''1i\
版权所有2016(c)Janus Fris Nielsen,保留所有权利。\
\
'
许可证
----
*copycheck*在"Mozilla公共许可证2.0版"下获得许可。有关详细信息,请参见
"许可证"或"常见问题解答"。
总之,您可以对任何封闭或开放源代码项目使用*copycheck*
,而不影响较大工作的许可证,只要您:
-在信用到期时给予信用,
-并发布任何自定义更改到*copycheck*
…_` Mozilla公共许可2.0版:http://www.mozilla.org/mpl/2.0
。_`许可证":许可证
…_`常见问题解答:`:http://www.mozilla.org/mpl/2.0/faq.html
_` janudn/copycheck`:https://github.com/janudn/copycheck
contribution
----
>在进行更改时,请记住更新"changelog.rst"。
building copycheck
-
确保您拥有符合要求的python 3.5环境结果。
例如,使用pyenv:
…代码块::bash
$pyenv virtualenv 3.5.0 copycheck venv
$pyenv activate copycheck venv
确保pip是最新的:
代码块::bash
$pip install--升级pip
安装要求:
…代码块::bash
$pip install--upgrade-r requirements.txt
构建轮子:
…代码块::bash
development
~~~~~~~~~~~~~
在开发过程中,使用以下命令在本地环境中安装包。
。代码块::bash
$pip install-e.
这允许您直接更改代码和测试*copycheck*
releasing
--
提交更改
2。推动变化
3。与master合并
4.更新本地主机
5。查找下一版本,例如6.6.6
6。创建名为core/release-6.6.6的新分支。关于py
8中的凹凸版本。运行`./release.sh 6.6.6`
上载到pypi
----
首先,执行测试上载以验证一切正常。
然后执行实际上载。
确保正确定义了以下环境变量:
。代码块::bash
$export pypi_test_username=<;username>;
$export pypi_test_password=<;your_test_password>;
$export pypi_username=<;your_password>;
$export pypi_password=<;username>;"
测试上传到pypi
~~~~~~~~~~~~~~~~~~~~~~~~~~~
>您可能需要在pypi测试服务器上注册。这可以在这里完成:
…代码块::bash
$https://testpypi.python.org/pypi
register:
……代码块::bash
$tween register-u${pypi_test_username}-p${pypi_test_password}-r https://testpypi.python.org/pypi dist/copycheck-6.6.6-py3-none-any.whl
upload
代码块::bash
$tween upload-u${pypi_test_username}-p${pypi_test_password}-r https://testpypi.python.org/pypi dist/copycheck-6.6.6-py3-none-any.whl
转到:
……代码块::bash
$https://testpypi.python.org/pypi/copycheck/6.6
检查一切看起来都很好。
代码块::bash
$python setup.py—详细说明rst2html.py—无原始输出>;output.html
>测试是否安装(在其他环境中执行):
代码块::bash
$pip install-i https://testpypi.python.org/pypi copycheck
>真正上传到pypi
~~~~~~~~~~~~~~~~~~~~~
upload
……代码块::bash
$tween upload-u${pypi_username}-p${pypi_password}-r https://pypi.python.org/pypi dist/copycheck-6.6.6-py3-none-any.whl
转到:
……代码块::bash
$https://pypi.python.org/pypi/copycheck/6.6.6
,检查所有东西看起来都很好。
谢谢
----
一个bug谢谢您找到了*pathspec*包的作者。使用*pathspec*
可以更容易地构建此工具。
更改日志
==
此文件中将记录对copycheck工具的所有显著更改。
此项目遵循[语义版本控制](http://semver.org/)。
有关如何更新此文件的信息。
[unreleased]
----
[1.0.3]
----
自述文件
[1.0.1]
----
/>
已弃用
~~~~~~~~~~
-没有更改
已删除
~~~~~
-没有更改
~~已修复
~~~~
-没有更改
>安全性
~~~~~
-没有更改
==
2016年janus fris nielsen版权所有。
此文件是*copycheck*
图片::https://circleci.com/gh/janudn/copycheck/tree/master.svg?style=shield&circle token=4112427381753afc2f073a61fba23263d1f86d13
:target:https://circleci.com/gh/janudn/copycheck/tree/master
introduction
----
*copycheck*检查所有文件的开头报告没有版权的任何文件
头。
版权标题的识别是非常初级的。*copycheck*扫描
10行的第一行,查看是否有"版权"一词出现在任何框中。
代码块::bash
$pip install copycheck
*copycheck*也可以从源代码安装:
…代码块::bash
$python setup.py install
…_` pypi`:http://pypi.python.org/pypi/copycheck
。_` setuptools`:https://pypi.python.org/pypi/setuptools
用法
----
如果给定
`--help`选项:
代码块::bash
$copycheck--help
用法:copycheck[-h][-v][--debug debug]{check}…
缺少版权标题
可选参数:
-h,--help显示此帮助消息并退出
-v,--verbose enable verbose output
--调试启用调试输出
检查当前目录中的所有文件
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
……代码块::bash
$copycheck check。
检查目录中的所有文件代码块::bash
$copycheck check path/to/directory
代码块::bash
$copycheck-path/to/directory-path/to/another/directory/and/so/on/。
ignore-files
~~~~~~~~~~
野生匹配。与在.gitignore中使用的相同。
代码块::bash
$copycheck check path/to/directory_sort
add copyright header
~~~~~~~~~~~~~~~~~~~~~~~
add copyright header to all python files available from current directory"
"…代码块::bash
$copycheck check。| Sort grep"\.py"xargs-l1 sed-i'''1i\
版权所有2016(c)Janus Fris Nielsen,保留所有权利。\
\
'
许可证
----
*copycheck*在"Mozilla公共许可证2.0版"下获得许可。有关详细信息,请参见
"许可证"或"常见问题解答"。
总之,您可以对任何封闭或开放源代码项目使用*copycheck*
,而不影响较大工作的许可证,只要您:
-在信用到期时给予信用,
-并发布任何自定义更改到*copycheck*
…_` Mozilla公共许可2.0版:http://www.mozilla.org/mpl/2.0
。_`许可证":许可证
…_`常见问题解答:`:http://www.mozilla.org/mpl/2.0/faq.html
_` janudn/copycheck`:https://github.com/janudn/copycheck
contribution
----
>在进行更改时,请记住更新"changelog.rst"。
building copycheck
-
确保您拥有符合要求的python 3.5环境结果。
例如,使用pyenv:
…代码块::bash
$pyenv virtualenv 3.5.0 copycheck venv
$pyenv activate copycheck venv
确保pip是最新的:
代码块::bash
$pip install--升级pip
安装要求:
…代码块::bash
$pip install--upgrade-r requirements.txt
构建轮子:
…代码块::bash
development
~~~~~~~~~~~~~
在开发过程中,使用以下命令在本地环境中安装包。
。代码块::bash
$pip install-e.
这允许您直接更改代码和测试*copycheck*
releasing
--
提交更改
2。推动变化
3。与master合并
4.更新本地主机
5。查找下一版本,例如6.6.6
6。创建名为core/release-6.6.6的新分支。关于py
8中的凹凸版本。运行`./release.sh 6.6.6`
上载到pypi
----
首先,执行测试上载以验证一切正常。
然后执行实际上载。
确保正确定义了以下环境变量:
。代码块::bash
$export pypi_test_username=<;username>;
$export pypi_test_password=<;your_test_password>;
$export pypi_username=<;your_password>;
$export pypi_password=<;username>;"
测试上传到pypi
~~~~~~~~~~~~~~~~~~~~~~~~~~~
>您可能需要在pypi测试服务器上注册。这可以在这里完成:
…代码块::bash
$https://testpypi.python.org/pypi
register:
……代码块::bash
$tween register-u${pypi_test_username}-p${pypi_test_password}-r https://testpypi.python.org/pypi dist/copycheck-6.6.6-py3-none-any.whl
upload
代码块::bash
$tween upload-u${pypi_test_username}-p${pypi_test_password}-r https://testpypi.python.org/pypi dist/copycheck-6.6.6-py3-none-any.whl
转到:
……代码块::bash
$https://testpypi.python.org/pypi/copycheck/6.6
检查一切看起来都很好。
代码块::bash
$python setup.py—详细说明rst2html.py—无原始输出>;output.html
>测试是否安装(在其他环境中执行):
代码块::bash
$pip install-i https://testpypi.python.org/pypi copycheck
>真正上传到pypi
~~~~~~~~~~~~~~~~~~~~~
upload
……代码块::bash
$tween upload-u${pypi_username}-p${pypi_password}-r https://pypi.python.org/pypi dist/copycheck-6.6.6-py3-none-any.whl
转到:
……代码块::bash
$https://pypi.python.org/pypi/copycheck/6.6.6
,检查所有东西看起来都很好。
谢谢
----
一个bug谢谢您找到了*pathspec*包的作者。使用*pathspec*
可以更容易地构建此工具。
更改日志
==
此文件中将记录对copycheck工具的所有显著更改。
此项目遵循[语义版本控制](http://semver.org/)。
有关如何更新此文件的信息。
[unreleased]
----
[1.0.3]
----
自述文件
[1.0.1]
----
/>
已弃用
~~~~~~~~~~
-没有更改
已删除
~~~~~
-没有更改
~~已修复
~~~~
-没有更改
>安全性
~~~~~
-没有更改