checkoutmanager

提供对您的git/hg/bzr/svn检出/克隆的概览和控制。

这些详情尚未由PyPI验证

项目链接

主页

项目描述

根据配置文件 (.checkoutmanager.cfg) 在多个位置创建bzr/hg/git/svn检出。这个配置文件位于您的家目录中。

优点：您有一个命令可以更新所有检出。您还可以请求未提交更改的列表。您只需复制配置文件即可在新的机器上重新构建整个检出结构（这实际上是我构建它的目的：我换工作时不得不更换笔记本电脑…）。

Checkoutmanager适用于linux，osx和windows。

开始使用

开始使用非常简单。只需 pip install checkoutmanager 并运行 checkoutmanager。

第一次，您将获得一个示例配置，您可以将其复制到您家目录中的 .checkoutmanager.cfg。
第二次，您将获得使用说明。（您需要运行 checkoutmanager co 以获取初始检出）。

通用用法

每天早上到公司后，我通常会执行checkoutmanager up操作。这会从服务器上抓取所有签出文件的最新版本。所以对于subversion签出文件，执行svn up，对于mercurial，执行hg pull -u，等等。

时不时地，我会执行checkoutmanager st来检查是否有未提交的文件。如果你一天中在几个目录中工作，这非常方便：它可以帮助你防止整个星期忘记提交那个bug修复。

新项目意味着我在配置文件中添加一行，然后运行checkoutmanager co。

Checkoutmanager允许你在多个目录中分散你的签出文件。但是它不能在每个目录中混合版本控制系统。例如，我有一个~/buildout/目录，其中包含我的大型subversion网站项目；还有一个包含我的subversion工作Python库的目录；还有一个~/hg/目录，其中包含我的mercurial项目。我在家目录中签出了几个配置目录，如~/.emacs.d，~/.subversion等等。一切正常工作。

命令

可用命令

exists: 打印签出是否存在或缺失
up: 从服务器抓取最新版本。
st: 打印签出文件的状态
co: 从服务器抓取缺失的签出文件
missing: 打印配置文件中缺失的目录
out: 显示尚未推送到服务器的更改集
in: 显示与“up”一起拉取的传入更改集。对于某些版本控制系统，这取决于相应命令的英文输出，因此本质上是不稳定的。

隐藏命令

一些命令是隐藏的，因为它们很少使用，并且仅对subversion有用。

upgrade: 此命令将工作副本升级到.svn目录的新subversion 1.7布局。在将subversion升级到1.7后，应执行此操作一次。请注意，如果你意外地运行了两次，你会得到一个错误，但不会损坏任何东西。由于此命令很少需要，因此它不在命令行帮助中宣传。
info: 显示远程URL的svn信息。当你更新了svn程序，并且你的操作系统的安全机制现在要求你明确允许访问存储的凭据时，这很有用。其他命令要么不访问互联网，要么是非交互式的（如命令up）。实际上，添加此命令的原因是非交互式“svn update”会在你尚未为新svn程序授予对凭据的访问权限时失败。这对我来说已经发生得太频繁了（Maurits）。

输出目录命名

如果你没有为签出URL指定输出目录名，它将只取最后一部分。为了使生活更简单，我们进行了一些调整

https://xxx/yyy/product/trunk变为product而不是trunk。（对subversion很有用）
https://xxx/yyy/product/branches/experiment变为product_experiment而不是experiment。（对subversion很有用）
https://xxx/customername/buildout/trunk变为customername而不是“trunk”或“buildout”。（我们仍然支持的老约定）
Bzr签出以“lp:”（特殊的launchpad URL）开头，其“lp:”将被移除。
Git签出将url末尾的“.git”移除。
如果您想保留版本控制系统的目录配置，请将 preserve_tree 选项添加到一组中。它应包含一个或多个基本检出 URL（每行一个）。如果检出 URL 以 preserve_tree URL 之一开头，则保留其后的文件夹结构。

使用 preserve_tree 的 https://github.com，https://github.com/reinout/checkoutmanager 变为 reinout/checkoutmanager 而不是 checkoutmanager。对于经常有嵌套目录的子版本控制也很方便。

如果找不到 preserve_tree 基础 URL，则使用标准规则，因此您不会收到错误。

如果您想从上述默认设置中获取不同的行为，只需在配置文件中 URL 后指定一个目录名（用空格分隔）即可。因此，https://github.com/reinout/checkoutmanager bla_bla 变为 bla_bla 而不是 checkoutmanager

自定义命令

您可以编写自己的自定义命令。为了这样做，您需要创建一个 Python 包并在您的 setup.py 中为 checkoutmanager.custom_actions 目标注册一个入口点。

checkoutmanager 包含一个 test 命令，可作为示例。它在其自己的 setup.py 中注册如下：

entry_points={
    'checkoutmanager.custom_actions': [
        'test = checkoutmanager.tests.custom_actions:test_action'
     ]
}

入口点函数必须接受一个位置参数，它将是与正在执行命令的目录关联的 checkoutmanager.dirinfo.DirInfo 实例。函数还可以接受可选的关键字参数。请参阅 checkoutmanager.tests.custom_actions.test_action 以获取示例。

使用以下语法将参数传递给自定义命令：

checkoutmanager action:arg1=val1,arg2=val2

配置文件

示例配置文件

# Sample config file.  Should be placed as .checkoutmanager.cfg in your home
# directory.
#
# There are different sections per base location and version control
# system.
#
# ``checkoutmanager co`` checks them all out (or clones them).
# ``checkoutmanager up`` updates them all.
# ``checkoutmanager st`` to see if there are uncommitted changes.
# ``checkoutmanager out`` to see if there are unpushed git/hg commits.


[git-example]
vcs = git
basedir = ~/example/git
checkouts =
    https://github.com/reinout/checkoutmanager
    git@github.com:django/django.git


[recipes]
# Buildout recipes I work on.
vcs = svn
basedir = ~/example/svn
checkouts =
    http://svn.zope.org/repos/main/z3c.recipe.usercrontab/trunk


[hg-example]
vcs = hg
basedir = ~/example/utilities
checkouts =
    https://bitbucket.org/reinout/eolfixer
    https://bitbucket.org/reinout/createcoverage


# [dotfolders]
# # Advanced usage!
# # Folders that end up as dotted configfolders in my home dir.
# # Note that there's a directory name behind the repository
# # location, separated by a space.
# vcs = bzr
# basedir = ~
# checkouts =
#     lp:emacsconfig/trunk .emacs.d
#     sftp://somewhere/subversion/trunk .subversion
# # By ignoring everything, we do not find missing import files but also
# # don't get warnings for every subdirectory in our home dir
# ignore =
#     *
#     .*

待办事项

等待反馈，以便我可以改进文档。
也许可以制作一个更好的示例配置（一个实际可以工作的而不是为自动化测试而构建的配置）。
现代化测试设置（pytest 而不是 zope 的 testrunner + doctests）。

致谢

由 Reinout van Rees 创建。
“out” 命令由 Dmitrii Miliaev 编写。
Git 支持由 Robert Kern 提供。
Globbing 支持由 Patrick Gerken 提供。
自定义命令支持由 Rafael Oliveira 提供。
并行化代码由 Morten Lied Johansen 提供。

源代码在 github 上，网址为 https://github.com/reinout/checkoutmanager。

可以在 https://github.com/reinout/checkoutmanager/issues 上报告错误和功能请求。