.. contents:: :depth: 1
Introduction
============
.. figure:: https://fschulze.github.io/mr.developer/xkcd-buildout.png
:figwidth: image
Let Mr. Developer help you win the everlasting buildout battle!
(Remixed by Matt Hamilton, original from https://xkcd.com/303)
**mr.developer** is a `zc.buildout`_ extension that makes it easy to work with
buildouts containing lots of packages, of which you only want to develop some.
The basic idea comes from Wichert Akkerman's plonenext effort.
.. _`zc.buildout`: https://pypi.org/project/zc.buildout/
Usage
=====
Add ``mr.developer`` to the ``extensions`` entry in your ``[buildout]``
section::
[buildout]
extensions = mr.developer
This enables additional ``[buildout]`` options:
``sources``
This specifies the name of a section which lists the repository
information for your packages. Defaults to ``sources``.
``sources-dir``
This specifies the default directory where your development packages will
be placed. Defaults to ``src``.
``auto-checkout``
This specifies the names of packages which should be checked out during
buildout. Packages already checked out are skipped. You can use ``*`` as
a wildcard for all packages in ``sources``.
``always-checkout``
This defaults to ``false``. If it's ``true``, then all packages specified
by ``auto-checkout`` and currently in develop mode are updated during each
buildout run. If set to ``force``, then packages are updated even when
they are dirty instead of asking interactively.
``update-git-submodules``
This defaults to ``always``. If it's ``always``, then submodules present
in each package in develompent will be registered and updated on checkout and
new ones on updates via the develop command. If you don't want to initialize any submodule,
set value to ``never``. If you set the value to ``checkout``,
code inside submodules will be pulled only the first time, so the ``develop up`` command
will leave the submodule empty. Note that update only initializes
new submodules, it doesn't pull newest code from original submodule repo.
``always-accept-server-certificate``
This defaults to ``false``. If it's ``true``, invalid server
certificates are accepted without asking (for subversion repositories).
``mr.developer-threads``
This sets the number of threads used for parallel checkouts. See
`Lockups during checkouts and updates`_ why you might need this.
``git-clone-depth``
This sets the git clone history size (git clone --depth parameter).
Not really useful for development, but really useful on CI environments.
The other big benefit is the speedup on cloning,
as only few revisions are downloaded.
Default is to get the full history.
The format of entries in the ``[sources]`` section is::
[sources]
name = kind url [key=value ...]
Where individual parts are:
``name``
The package name.
``kind``
The kind of repository. Currently supported are ``svn``,
``hg``, ``git``, ``bzr``, ``darcs``, ``cvs``, or ``fs``.
``url``
The location of the repository. This value is specific to the version
control system used.
``key=value``
You can add options for each individual package with this. No whitespace is
allowed in ``key``, ``value``, and around the equal sign. For a
description of the options see below. (*Note*: don't surround your ``key=value``
with square brackets: we only use ``[ ]`` here to indicate that it
is optional to add options.)
The per-package options are:
Common options
The ``path`` option allows you to set the base directory where the
package will be checked out. The name of the package will be appended to
the base path. If ``path`` is not set, ``sources-dir`` is used.
With ``full-path`` you can set the directory where the package will be
checked out. This is the actual destination, nothing will be added. As
an example::
[sources]
pkg = fs pkg full-path=/path/to/pkg
The ``update`` option allows you to specify whether a package will be
updated during buildout or not. If it's ``true``, then it will always be
updated. If it's ``false``, then it will never be updated, even if the
global ``always-checkout`` option is set.
The ``egg`` option makes it possible to manage packages which are not
eggs with ``egg=false``. All commands like ``update`` work as expected,
but the package isn't added to the ``develop`` buildout option and the
``activate`` and ``deactivate`` commands skip the package.
The ``newest_tag`` option allows you to checkout/update to the newest tag.
Possible values of the option are "true" and "false".
The ``newest_tag_prefix`` option allows you to limit the selection of tags to
those which start with the prefix.
These two options currently only work for ``cvs`` and ``hg``.
``svn``
The ``url`` is one of the urls supported by subversion.
You can specify a url with a revision pin, like
``https://example.com/trunk@123``.
You can also set the ``rev`` or ``revision`` option, which is either a pin
like with ``rev=123`` or a minimum revision like ``rev=>123`` or
``rev=>=123``. When you set a minimum revision, the repository is updated
when the current revision is lower.
``git``
The ``branch`` option allows you to use a specific branch instead of
master.
The ``rev`` option allows you to use a specific revision (usually a
tag) instead of the HEAD.
The ``pushurl`` options allows you to explicitly separate push url from pull
url, configured by git config.
The ``submodules`` option allows you to initialize existing submodules.
Default value is controled by the buildout option ``update-git-submodules``.
Possible values are the same described before in ``update-git-submodules`` option,
The ``depth`` option allows to specify how much history you want to clone.
This is the so called *shallow clones*.
Note that this is mostly not useful at all for regular clones,
on the other hand for one time usages (continuous integration for example) it makes clones much faster.
This option overrides a general ``git-clone-depth`` value,
so per-source depth can be specified.
Note that the ``branch`` and ``rev`` option are mutually exclusive.
``hg``
The ``branch`` option allows you to use a specific branch instead of
default.
The ``rev`` option allows you to force a specific revision
(hash, tag, branch) to be checked out after buildout
``bzr``
Currently no additional options.
``darcs``
Currently no additional options.
``cvs``
The ``cvs_root`` option can be used to override the setting of the $CVSROOT
environment variable.
The ``tag`` option forces checkout/update of the given tag instead of CVS
HEAD.
The ``tag_file`` option defines from which file tags will be read (in case of
using ``newest_tag``). Default value is "setup.py".
``fs``
This allows you to add packages on the filesystem without a version
control system, or with an unsupported one. You can activate and
deactivate packages, but you don't get status info and can't update etc.
The ``url`` needs to be the same as the ``name`` of the package.
Here's an example of how your ``buildout.cfg`` may look like::
[buildout]
extensions = mr.developer
auto-checkout = my.package
[sources]
my.package = svn https://example.com/svn/my.package/trunk update=true
some.other.package = git git://example.com/git/some.other.package.git
When you run buildout, the script ``bin/develop`` is created in your
buildout directory. With this script you can perform various actions on
packages, like checking out their source code, without the need to know where
the repositories are located.
For help on what the script can do, run ``bin/develop help``.
If you checked out the source code of a package, you must run buildout again.
The new package will then be marked as a development egg and have its version
pin cleared (if any). You can control the list of development eggs explicitely
with the ``activate`` and ``deactivate`` commands.
Any source where the path is a symlink is skipped during updates, as it is
assumed, that the developer handles it manually. It is basically treated like
a filesystem source.
Configuration
=============
You can add options to your global ``~/.buildout/mr.developer.cfg`` or local
``.mr.developer-options.cfg`` in your buildout. Don't ever edit
``.mr.developer.cfg`` in your buildout though, it's generated automatically.
In the ``[mr.developer]`` section you have the following options.
``threads``
This sets the number of threads used for parallel checkouts. See
`Lockups during checkouts and updates`_ why you might need this.
In the ``[rewrites]`` section you can setup rewrite rules for sources. This is
useful if you want to provide a buildout with sources to repositories which have
different URLs for repositories which are read only for anonymous users. In that
case developers can add a URL rewrite which automatically changes the URL to a
writable repository.
The rewrite rules can have multiple operators:
``=``
Matches the exact string. Useful to only operated on sources of a certain kind
and similar things. This doesn't rewrite anything, but limits the rule.
``~=``
Matches with a regular expression. This doesn't rewrite anything, but limits
the rule.
``~``
This runs a regular expression substitution. The substitute is read from the
next line. You can use groups in the expression and the backslash syntax in
the substitute. See `re.sub`_ documentation.
.. _`re.sub`: https://docs.python.org/3/library/re.html#re.sub
The following are useful examples::
[rewrites]
plone_svn =
url ~ ^http://svn.plone.org/svn/
https://svn.plone.org/svn/
github =
url ~ ^https://github.com/
git@github.com:
kind = git
my_mrdeveloper_fork =
url ~ fschulze(/mr.developer.git)
me\1
my_mrdeveloper_fork_alternate =
url ~= fschulze/mr.developer.git
url ~ fschulze/
me/
Extending
=========
You can extend mr.developer to teach it new types of Working Copies
and to add or modify existing commands.
Mr.developer uses entrypoints for this. TO see examples on how to create entry
points in detail, you can have a look at the existing entry points.
Adding support for a new working copy type
------------------------------------------
Add en entry to the entry point group ``mr.developer.workingcopytypes``.
They key of the entry is going to be used in the sources section of your
buildout file. The value should be a class.
The referenced class must implement the following methods::
- __init__(self, source)
- matches(self)
- checkout(self, **kwargs)
- status(self, verbose=False, **kwargs)
- update(self, **kwargs)
The source is a dictionary like object. The source object provides the
attributes::
- name
- url
- path
In addition it contains all key value pairs one can define on the source line
in buildout, and a methods ``exists`` that returns, whether the ``path``
already exists.
The matches method must return, if the checkout at the ``path`` matches the
repository at ``url``
The commands map to the commands mr.developer provides. To see the list of
potential arguments, check the documentation of the commands.
The commands ``checkout`` and update only return what they want to have printed
out on stdout, the ``status`` command must check the verbose flag. If the
verbose flag is set, it must return a tuple with what it wants to print out and
what the VCS commands generated as output.
All objects must have list ``_output`` which contains logging information.
Please refer to existing implementations for how to fill this information.
If your working copy Handler needs to throw an error, throw errors with
``mr.developer.common.WCError`` as a base clase.
If you need to add new functionality for new commands or change behavior of
something, try not to write a new working copy handler. Try your best your
changes generically useful and get them into mr.developer.
Adding a new command
--------------------
Add an entry to the entry point group ``mr.developer.commands``.
The key will be the name of the command itself.
The referenced class must implement the following methods::
- __init__(self, develop)
- __call__(self, args)
An inversion of control happens here. On initalization, you receive a develop
object that represents the class handling invocation of ``./bin/develop``
It is now your job to modify the attributes of the ``develop`` object to handle
argument parsing.
Create an ArgumentParser and add it to ``develop.parsers``.
Upon calling, you can perform your actions. It is a good idea to subclass from
``mr.developer.commands.Command``. It provides convenient helper methods::
- get_workingcopies(self, sources)
- get_packages(args, auto_checkout, develop, checked_out)
``get_workingcopies`` gives you a WorkingCopies object that will delegate all
your working copy actions to the right working copy handler.
``get_packages`` is a little helper to get sources filterd by the rules.
``args`` can be one or more regular expression filtr on source names, the other
attributes are boolean flags that by default are ``False``. False means _not_
to filter. Calling the method only with the ``arg`` '.' would thus return all
packges. THe returned object is a set containing only the names of the sources.
To perform an action, you get the package names via get_packages. then you get
the WorkingCopies object and call the action you want to perform on this
object. THe WorkingCopies object checks, which working copy is responsible for
the given package and delegates the action to this object. The WorkingCopies
object is also handling threading functionality.
The ``develop`` object has a ``config`` property. This object can be used to
store configuration of your actions. under ``config.develop`` a dictionary
resides which stores, whether the source with the given key is going to be used
from source checkout.
Troubleshooting
===============
Dirty SVN
---------
You get an error like::
ERROR: Can't switch package 'foo' to 'https://example.com/svn/foo/trunk/' because it's dirty.
If you have not modified the package files under src/foo, then you can check
what's going on with ``status -v``. One common cause is a ``*.egg-info`` folder
which gets generated every time you run buildout and this shows up as an
untracked item in svn status.
You should add .egg-info to your global Subversion ignores in
``~/.subversion/config``, like this::
global-ignores = *.o *.lo *.la *.al .libs *.so *.so.[0-9]* *.a *.pyc *.pyo *.rej *~ #*# .#* .*.swp .DS_Store *.egg-info
HTTPS Certificates
------------------
The best way to handle https certificates at the moment, is to accept them
permanently when checking out the source manually.
Mercurial reports mismatching URL
---------------------------------
This happens if you use lp:// URLs from launchpad. The problem is, that hg
reports the actual URL, not the lp shortcut.
Lockups during checkouts and updates
------------------------------------
Especially on multicore machines, there is an issue that you can get lockups
because of the parallel checkouts. You can configure the number of threads used
for this in ``.mr.developer.cfg`` in the buildout root of your project or
globally in ``~/.buildout/mr.developer.cfg`` through the ``threads`` option
in the ``[mr.developer]`` section or in your buildout in the ``buildout``
section with the ``mr.developer-threads`` option. Setting it to ``1`` should
fix these issues, but this disables parallel checkouts and makes the process a
bit slower.
Also, if you have `ControlPersist` in your local ssh config, and you
have a source checkout that uses ssh (for example
``git@github.com:...``) the checkout or update may work fine, but the
ssh connection may stay open and ``mr.developer`` cannot exit because
it waits for the ssh process to finish.
Commands
========
The following is a list of all commands and their options.
activate (a)
------------
::
usage: develop activate [-h] [-a] [-c] [-d]
package-regexp [package-regexp ...]
Add packages to the list of development packages.
positional arguments:
package-regexp A regular expression to match package names.
optional arguments:
-h, --help show this help message and exit
-a, --auto-checkout Only considers packages declared by auto-checkout. If
you don't specify a <package-regexps> then all declared
packages are processed.
-c, --checked-out Only considers packages currently checked out. If you
don't specify a <package-regexps> then all checked out
packages are processed.
-d, --develop Only considers packages currently in development mode.
If you don't specify a <package-regexps> then all
develop packages are processed.
arguments (args)
----------------
::
usage: develop arguments [-h]
Print arguments used by last buildout which will be used with the 'rebuild'
command.
optional arguments:
-h, --help show this help message and exit
checkout (co)
-------------
::
usage: develop checkout [-h] [-a] [-v] package-regexp [package-regexp ...]
Make a checkout of the packages matching the regular expressions and add them
to the list of development packages.
positional arguments:
package-regexp A regular expression to match package names.
optional arguments:
-h, --help show this help message and exit
-a, --auto-checkout Only considers packages declared by auto-checkout. If
you don't specify a <package-regexps> then all declared
packages are processed.
-v, --verbose Show output of VCS command.
deactivate (d)
--------------
::
usage: develop deactivate [-h] [-a] [-c] [-d]
package-regexp [package-regexp ...]
Remove packages from the list of development packages.
positional arguments:
package-regexp A regular expression to match package names.
optional arguments:
-h, --help show this help message and exit
-a, --auto-checkout Only considers packages declared by auto-checkout. If
you don't specify a <package-regexps> then all declared
packages are processed.
-c, --checked-out Only considers packages currently checked out. If you
don't specify a <package-regexps> then all checked out
packages are processed.
-d, --develop Only considers packages currently in development mode.
If you don't specify a <package-regexps> then all
develop packages are processed.
help (h)
--------
::
usage: develop help [-h] [--rst] [-z] [command]
Show help on the given command or about the whole script if none given.
positional arguments:
command The command you want to see the help of.
optional arguments:
-h, --help show this help message and exit
--rst Print help for all commands in reStructuredText format.
-z, --zsh Print info for zsh autocompletion
info
----
::
usage: develop info [-h] [-a] [-c] [-d] [--name] [-p] [--type] [--url]
[package-regexp [package-regexp ...]]
Lists informations about packages.
positional arguments:
package-regexp A regular expression to match package names.
optional arguments:
-h, --help show this help message and exit
-a, --auto-checkout Only considers packages declared by auto-checkout. If
you don't specify a <package-regexps> then all declared
packages are processed.
-c, --checked-out Only considers packages currently checked out. If you
don't specify a <package-regexps> then all declared
packages are processed.
-d, --develop Only considers packages currently in development mode.
If you don't specify a <package-regexps> then all
declared packages are processed.
Output options:
The following options are used to print just the info you want, the order
they are specified reflects the order in which the information will be
printed.
--name Prints the name of the package.
-p, --path Prints the absolute path of the package.
--type Prints the repository type of the package.
--url Prints the URL of the package.
list (ls)
---------
::
usage: develop list [-h] [-a] [-c] [-d] [-l] [-s]
[package-regexp [package-regexp ...]]
Lists tracked packages.
positional arguments:
package-regexp A regular expression to match package names.
optional arguments:
-h, --help show this help message and exit
-a, --auto-checkout Only show packages in auto-checkout list.
-c, --checked-out Only considers packages currently checked out. If you
don't specify a <package-regexps> then all checked out
packages are processed.
-d, --develop Only considers packages currently in development mode.
If you don't specify a <package-regexps> then all
develop packages are processed.
-l, --long Show URL and kind of package.
-s, --status Show checkout status.
The first column in the output shows the checkout
status:
'#' available for checkout
' ' in auto-checkout list and checked out
'~' not in auto-checkout list, but checked out
'!' in auto-checkout list, but not checked out
'C' the repository URL doesn't match
purge
-----
::
usage: develop purge [-h] [-n] [-f] [package-regexp [package-regexp ...]]
Remove checked out packages which aren't active anymore.
Only 'svn' packages can be purged, because other repositories may contain
unrecoverable files even when not marked as 'dirty'.
positional arguments:
package-regexp A regular expression to match package names.
optional arguments:
-h, --help show this help message and exit
-n, --dry-run Don't actually remove anything, just print the paths which
would be removed.
-f, --force Force purge even if the working copy is dirty or unknown
(non-svn).
rebuild (rb)
------------
::
usage: develop rebuild [-h] [-n]
Run buildout with the last used arguments.
optional arguments:
-h, --help show this help message and exit
-n, --dry-run DEPRECATED: Use 'arguments' command instead. Don't actually
run buildout, just show the last used arguments.
reset
-----
::
usage: develop reset [-h] [-a] [-c] [-d] [package-regexp [package-regexp ...]]
Resets the packages develop status. This is useful when switching to a new
buildout configuration.
positional arguments:
package-regexp A regular expression to match package names.
optional arguments:
-h, --help show this help message and exit
-a, --auto-checkout Only considers packages declared by auto-checkout. If
you don't specify a <package-regexps> then all declared
packages are processed.
-c, --checked-out Only considers packages currently checked out. If you
don't specify a <package-regexps> then all checked out
packages are processed.
-d, --develop Only considers packages currently in development mode.
If you don't specify a <package-regexps> then all
develop packages are processed.
status (stat, st)
-----------------
::
usage: develop status [-h] [-a] [-c] [-d] [-v]
[package-regexp [package-regexp ...]]
Shows the status of tracked packages, filtered if <package-regexps> is given.
The first column in the output shows the checkout status:
' ' in auto-checkout list
'~' not in auto-checkout list
'!' in auto-checkout list, but not checked out
'C' the repository URL doesn't match
'?' unknown package (only reported when package-regexp is not specified)
The second column shows the working copy status:
' ' no changes
'M' local modifications or untracked files
'>' your local branch is ahead of the remote one
The third column shows the development status:
' ' activated
'-' deactivated
'!' deactivated, but the package is in the auto-checkout list
'A' activated, but not in list of development packages (run buildout)
'D' deactivated, but still in list of development packages (run buildout)
positional arguments:
package-regexp A regular expression to match package names.
optional arguments:
-h, --help show this help message and exit
-a, --auto-checkout Only considers packages declared by auto-checkout. If
you don't specify a <package-regexps> then all declared
packages are processed.
-c, --checked-out Only considers packages currently checked out. If you
don't specify a <package-regexps> then all checked out
packages are processed.
-d, --develop Only considers packages currently in development mode.
If you don't specify a <package-regexps> then all
develop packages are processed.
-v, --verbose Show output of VCS command.
update (up)
-----------
::
usage: develop update [-h] [-a] [-d] [-f] [-v]
[package-regexp [package-regexp ...]]
Updates all known packages currently checked out.
positional arguments:
package-regexp A regular expression to match package names.
optional arguments:
-h, --help show this help message and exit
-a, --auto-checkout Only considers packages declared by auto-checkout. If
you don't specify a <package-regexps> then all declared
packages are processed.
-d, --develop Only considers packages currently in development mode.
If you don't specify a <package-regexps> then all
develop packages are processed.
-f, --force Force update even if the working copy is dirty.
-v, --verbose Show output of VCS command.
Changelog
=========
2.0.2 (2024-04-24)
------------------
* Fix ValueError: too many values to unpack (expected 2). [flipmcf]
2.0.1 (2020-08-19)
------------------
* Fix ``bin/develop help`` on Python 3.
2.0.0 (2019-03-04)
------------------
* Remove deprecated ``-n``/``--dry-run`` option from ``rebuild``/``rb`` command.
[fschulze]
* Use universal_newlines to deal with all output for git.
[pbauer]
* Fix verbose status in python 3.
[pbauer]
* Drop testing with Python 2.6 and Python 3.3, from now on there is no
guarantee it will work with those Python versions.
[fschulze]
1.38 (2017-03-17)
-----------------
* Use ``from __future__ import print_function`` to fix output of ``help --rst``.
[fschulze]
* Set empty version pin for develop packages instead of removing the version
pin from the section.
[fschulze]
1.37 (2017-03-04)
-----------------
* Add more info on git operations, so one can see which repository is cloned
and which branch is used.
[fschulze]
* Fix git submodules with git 2.x.
[fschulze]
1.36 (2017-03-01)
-----------------
* Add the buildout option mr.developer-verbose that enables showing
the same out when running buildout as when running ./bin/develop up -v.
[sunew]
* Respect the buildout -v setting for updates, just as it already does for checkouts.
[sunew]
1.35 - 2017-02-01
-----------------
* Do not use the backport of configparser on Python2, to fix
"Option values must be strings" exception on some commands.
[MatthewWilkes]
* No longer test on Python 3.2. [maurits]
* Improve error message when a directory isn't found in fs mode.
[idgserpro]
1.34 - 2015-09-30
-----------------
* Remove support for python 2.4 and 2.5. Use python 2.6 or higher or python
3.2 or higher.
[reinout]
* Report missing executables (like 'hg') instead of reporting a too-generic
"file not found" error.
[reinout]
* Fix bug with assignments lacking the section. According to
buildout's documentation ``option=value`` is equivalent to
``buildout:option=value``.
Fixes issue #151
[mvaled]
* Fix switching to git branch from revision. When currently you are
not on a git branch (for example on a tag), running a develop update
would try to pull and fail. Now we simply fetch, and handle
possible branch switching and merging the same as we always do.
Fixes issue #162
[maurits]
* Fix unpinning of eggs with a name containing characters not in [^A-Za-z0-9.]
This means that to correctly unpin pkg.foo_bar we have to delete
``pkg.foo-bar`` from the buildout ``[version]`` section.
[ale-rt (Alessandro Pisa)]
* Checkout branch when cloning a git repository.
[gforcada]
1.33 - 2015-05-25
-----------------
* Fix git-clone-depth global option, it needs to be kept as a string and not
converted to a number.
[gforcada, fschulze]
1.32 - 2015-05-23
-----------------
* Add git-clone-depth global option and depth per source option to specify on
git clones how much history wants to be cloned.
[gforcada (Gil Forcada)]
* Add plugin interface for adding commands using entry points.
[fschulze]
* Raise an exception if the sources section references a missing section.
[icemac (Michael Howitz)]
1.31 - 2014-10-29
-----------------
* Fixed submodule matching for some git versions.
[jod (Josip Delic), fschulze]
* Added compat.py for Python 3.
[jod (Josip Delic)]
* More info when svn cannot switch because of dirty checkout.
[gotcha]
* Git: try to switch to branch master when no branch has been
specified. Do not give an error in this case when master is not
there. Fixes issue #125
[maurits]
1.30 - 2014-03-14
-----------------
* Fix regression from 1.29.
[Trii (Josh Johnston)]
1.29 - 2014-03-14
-----------------
* Preserve order of eggs specified in ``develop`` option.
[anjos (André Anjos)]
1.28 - 2014-01-23
-----------------
* Mercurial now checks if working copy is ahead of remote branch.
[rafaelbco]
1.27 - 2014-01-10
-----------------
* Fix encoding issues during installation if the default encoding isn't
properly set. Fixes issue #127
[fschulze, jajadinimueter]
* Fix error message when listing of git branches fails. Fixes issue #124
[toutpt (JeanMichel FRANCOIS), fschulze]
1.26 - 2013-09-10
-----------------
* Fixed branch option for git 1.6.0 until and including 1.6.2.
Fixes issue #117.
[maurits]
* Skip update of symlinked sources.
[chaoflow (Florian Friesdorf)]
* Deprecate ``-n`` and ``--dry-run`` on ``rebuild`` command in favour of the
new ``arguments`` command.
1.25 - 2013-03-15
-----------------
* Git submodules support.
[sunbit]
* Added `newest_tag` option for mercurial and cvs.
[kkujawinski, fschulze]
* Python 3 fixes.
[fschulze, jajadinimueter (Florian Mueller)]
* Fix revision pinning. Refs #113
[do3cc (Patrick Gerken)]
* Properly line up the output of ``status``.
[fschulze]
1.24 - 2013-01-29
-----------------
* Mercurial now switches branches.
[bubenkoff (Anatoly Bubenkov), fschulze]
* Fix gitsvn/gitify working copy type which was broken since 1.22.
[rpatterson (Ross Patterson)]
* Fix deactivate command which was broken since 1.22. Refs #105
[fschulze, icemac]
1.23 - 2012-11-28
-----------------
* Unit tests run with Python 2.4, 2.5, 2.6, 2.7 and 3.2 now.
[fschulze]
* Officially added source rewrites. Refs #56
[fschulze]
* Add additional optional config file ``.mr.developer-options.cfg`` which is
read from the buildout directory for local version controllable options.
[fschulze]
* Update all activated packages during buildout if ``always-checkout`` is true
instead of only the ones in the ``auto-checkout`` list or with the ``update``
option set. Refs #95
[fschulze]
* Fix asking for password for svn with basic authentication. Refs #100
[MordicusEtCubitus]
* Fixed regressions in svn module. Refs #37
[fschulze, evilbungle (Alan Hoey)]
* Fixed branch checkout for git on Python 3.
[mitchellrj]
* Fixed subversion checkout on Python 3.
[mitchellrj]
1.22 - 2012-10-13
-----------------
* If you set threads to 1, then we don't use any separate thread anymore, the
actions are now done in the main thread.
[fschulze]
* Allow configuration of the number of threads used through the buildout config
by setting the ``mr.developer-threads`` option in the ``buildout`` section.
[fschulze]
* For git repositories the ``status`` command shows you when your local branch
is ahead of the remote branch.
[fschulze]
* Always make ``sources-dir`` option available in buildout, even if it's set
to the default. Fixes #49
[fschulze]
* Parse revision from url for all svn commands. Fixes #37
[fschulze]
* Use entry points to allow adding and overwriting working copy types via
addon packages.
[fschulze]
* Fixed ValueError in verbose status for filesystem and gitsvn sources.
[maurits]
* Fixed some exceptions occurring when using with Python 3.
[icemac (Michael Howitz)]
* On Windows, use the PATHEXT environment variable to find the git executable.
[kleist]
1.21 - 2012-04-11
-----------------
* Added ``threads`` option to ``[mr.developer]`` section to set number of
threads used for running checkouts.
[fschulze]
* Read a per user config file from ~/.buildout/mr.developer.cfg in addition to
the regular .mr.developer.cfg in the current buildout base.
[fschulze]
* Python 3 support by using 2to3.
[mitchellrj (Richard Mitchell)]
1.20 - 2012-02-26
-----------------
* Git: Added ``pushurl`` option
[iElectric (Domen Kožar)]
* Refactored thread locking.
[shywolf9982]
* Refactored search for git executable and version handling.
[shywolf9982]
* In the status command report unknown packages with '?' when no
package-regexp has been given.
[maurits]
* Added --force option to purge command. Especially helpful in
purging non-subversion packages, which otherwise we refuse to
remove. Fixes issue #71.
[maurits]
* Do not depend on `elementtree` if there is `xml.etree` (Python >= 2.5).
* Don't set locale anymore when calling ``svn``. This may break if the output
is localized instead of english, I couldn't reproduce that anymore though.
[fschulze, rochecompaan (Roché Compaan)]
* Fix compatibility with mercurial v2.1
[janjaapdriessen (Jan-Jaap Driessen)].
1.19 - 2011-09-22
-----------------
* Git: Don't stop buildout after renaming/adding git remotes, i.e. when
actively working on a given package.
[witsch (Andreas Zeidler)]
* Bugfix: Honhour buildout:develop parameters even if ending with slash.
[lukenowak]
* Installation: Check presence of required modules instead of relying on
version of python.
[lukenowak (Łukasz Nowak)]
1.18 - 2011-08-16
-----------------
* Mercurial: Added support for branches.
[posborne (Paul Osborne)]
* Git: Added support for the Windows msysGit.
[canassa (Cesar Canassa)]
* Git: Added ``rev`` option that allows you to use a specific revision
(usually a tag) instead of the HEAD.
[maurits (Maurits van Rees)]
1.17 - 2011-01-26
-----------------
* Git: Default to branch ``master`` if no branch is given in the source.
[stefan]
* Brush up the README.
[stefan]
* Create the sources-dir if it is not present.
[janjaapdriessen]
* Only require argparse with Python < 2.7.
[dobe]
* Fixed issue #35 using bzr, similar to the fix #28 for hg in last version.
[menesis]
* Pass branch to bzr pull.
[menesis]
* Add support for darcs.
[lelit, azazel]
1.16 - 2010-09-16
-----------------
* Fix ``NameError: global name 'source' is not defined`` when using gitsvn
and running ``status`` command.
[markvl]
* Add handling of new ``-s`` command line option of zc.buildout 1.5, this
fixes issue #29.
[fschulze]
* Don't pass the PYTHONPATH onwards to mercurial, this fixes issue #28
[fschulze, Christian Zagrodnick]
* Fix saving buildout options on Windows. Issue #24
[fschulze]
* Only warn if the svn version is too old.
[fschulze]
1.15 - 2010-07-25
-----------------
* Use ``always-checkout`` option from buildout config for ``update`` command.
This fixes issue #18.
[fschulze]
* Fix ``OSError: [Errno 10] No child processes`` errors in Python 2.4 and 2.5.
(Issue #12)
[fschulze]
* Fix CVS update.
[sargo]
1.14 - 2010-05-15
-----------------
* Added bzr support.
[tseaver]
* Added git branch support.
[shywolf9982, fschulze]
1.13 - 2010-04-11
-----------------
* Tell the user which packages are queued for update or checkout, so one can
check which packages are still updating now that the output is only printed
after everything is done due to parallel checkouts.
[fschulze]
* Added ``always-accept-server-certificate`` option. When set in the
``[buildout]`` section, then invalid certificates are always accepted for
subversion repositories.
[fschulze]
* Added ``-v``/``--version`` option.
[tomster, fschulze]
* Use the much nicer argparse library instead of optparse.
[fschulze]
1.12 - 2010-03-15
-----------------
* Fix svn checkout.
[fschulze]
1.11 - 2010-03-14
-----------------
* Handle untrusted server certificates by asking the user what to do.
[fschulze]
* Properly handle user input for authorization by using locks to prevent
problems with parallel checkouts.
[fschulze]
* Only checkout/update packages in auto-checkout or with ``update = true``
option when running buildout.
[fschulze]
1.10 - 2010-02-06
-----------------
* Don't store the buildout options if they contain a command.
[fschulze]
* Basic support for buildout offline mode (-o). Not all cases are handled yet.
[fschulze]
* Added ``full-path`` package option.
[fschulze]
* Added ``egg`` package option (Issue #6).
[fschulze]
* By setting ``always-checkout = force``, all packages will be updated
without asking when dirty.
[fschulze]
* The ``[path]`` part of sources is replaced by ``path=PATH`` syntax and
throws a warning when used.
[fschulze]
* Per package options are now allowed before the URL.
[fschulze]
* Check ``svn`` version and output helpful error messages if it's too old or
can't be determined (Issue #13).
[fschulze]
* Error messages instead of tracebacks when source definitions are wrong.
[fschulze]
* Fix checkout of packages (Issues #9 and #11).
[fschulze]
* Possibility to checkout/update tags instead of HEAD in CVS
[sargo]
* Tests for CVS integration
[sargo]
* Better checking of CVS package purity.
[sargo]
1.9 - 2010-01-11
----------------
* Added dry-run option to ``purge`` command.
[fschulze]
* Fix purging on windows.
[kleist (Karl Johan Kleist)]
* Fix compatibility with Python < 2.6.
[fschulze, vincentfretin]
* Fix `all` answer for ``update`` command.
[fschulze]
1.8 - 2010-01-10
----------------
* Added threading for parallel checkouts.
[fschulze, jensens]
* Ask whether to update dirty packages during checkout.
[fschulze]
* When you answered `yes` when asked whether to update a dirty package, then
all further questions had been answered with `yes` as well, this is now
fixed.
[fschulze]
* Added `all` option when asked to update dirty packages.
[fschulze]
* Added help for all commands to PyPI description.
[fschulze]
* Added option to ``help`` command which outputs the help for all commands in
reStructuredText format.
[fschulze]
* Don't abort after user answered `no` on whether to update a package, just
skip that package.
[fschulze]
1.7 - 2009-11-26
----------------
* Fix a problem where a package wasn't added to the develop packages on auto
checkout.
[fschulze]
1.6 - 2009-11-21
----------------
* Filter the packages gathered from ``buildout:develop`` to ones declared in
sources, otherwise things like "develop = ." break.
[fschulze]
* Added support for Concurrent Versions System (CVS).
[sargo (Wojciech Lichota)]
1.5 - 2009-11-19
----------------
* Added global ``always-checkout`` and a per source ``update`` option.
[fschulze]
* Added ``purge`` command.
[fschulze]
* Ask user how to proceed when package is dirty.
[fschulze]
* Refactored package matching and made the command options consistent.
Now you can update only the packages currently in development with ``-d``
and similar possibilities.
[fschulze]
* Fix duplicate logging output.
[fschulze]
* Fix parsing of buildout arguments when ``-t`` was used.
[fschulze]
1.4 - 2009-11-16
----------------
* Allow to set a minimal revision for ``svn`` repositories. If the current
revision is lower, then the package is updated.
[fschulze]
1.3 - 2009-11-15
----------------
* Read the cfg used by last buildout run. This prevents unexpected behaviour,
if you change mr.developer options like source declarations and don't run
buildout. Such changes are now picked up immediately.
[fschulze]
* Added tests and a buildout to run them easily.
[fschulze]
1.2 - 2009-11-12
----------------
* If a package is removed from ``auto-checkout`` and wasn't explicitly
activated, then it will be removed from the develop packages automatically.
In existing buildouts with an older mr.developer, you have to ``reset`` the
packages first.
[fschulze]
* Added ``*`` wild card support for ``auto-checkout``.
[fschulze]
* Don't bail on subversion URLs ending in a slash or a revision marker.
[fschulze]
* Removed old way of specifying sources with ``sources-svn`` and
``sources-git``.
[fschulze]
* Exit immediately when there are issues during checkout when running as
extension.
[fschulze]
* Use verbosity from buildout when running as extension.
[fschulze]
* Fix buildout_dir in ``develop`` script, so it is properly escaped on
Windows.
[fschulze]
* Changed the output of ``list -s`` to match the one from ``status``.
[fschulze]
* Added troubleshooting section to readme.
[miohtama, fschulze]
* All commands have a ``-h`` and ``--help`` option now to show their help.
[fschulze]
1.1 - 2009-08-07
----------------
* Use relative paths from the buildout directory for the ``develop`` option
if possible. This fixes issues if your buildout path contains a space.
[fschulze]
* Warn when trying to activate or deactivate a package which isn't checked out.
[fschulze]
* Don't depend on elementree on Python >= 2.5, because it's builtin there.
[fschulze]
* When checking out a source it will automatically be activated.
[fschulze]
* Use 'sources' as the default section name for source information.
[fschulze]
* Added support for filesystem packages without version control with the
'fs' type.
[fschulze]
1.0.1 - 2009-05-05
------------------
* Fixed case sensitivity of package names for several commands.
[fschulze]
* SVN externals no longer cause a modified status.
[fschulze]
1.0 - 2009-05-02
----------------
* Added ``info`` command to print various informations about packages.
[fschulze]
* Added ``reset`` command to reset the develop state of packages. This is
useful when switching to a new buildout configuration. During the next
buildout run the develop state is determined the same way as in a clean
buildout.
[fschulze]
* Got rid of deprecation warning in Python 2.6 by removing unnecessary call
of __init__ in working copy implementations.
[fschulze]
0.15 - 2009-04-17
-----------------
* Added reminder to run buildout after activating or deactivating packages.
[fschulze]
* Added ``rebuild`` command to rerun buildout with the last used arguments.
[fschulze]
0.14 - 2009-04-16
-----------------
* Fixed verbose output of ``checkout`` command.
[fschulze]
* Added ``-f`` option to ``update`` command to force updates even if the
working copy is dirty.
[fschulze]
0.13 - 2009-04-14
-----------------
* Added ``-a`` option to ``update`` command to only update the packages
declared in the ``auto-checkout`` list.
[fschulze]
* Added ``activate`` and ``deactivate`` commands. This allows to select which
packages are added to the ``develop`` option of zc.buildout. Enhanced the
``status`` command to show the additional informations.
[fschulze]
* Switched the meaning of ``~`` and ``C`` in status command.
[fschulze]
0.12 - 2009-04-14
-----------------
* Added support for Mercurial (hg).
[mj]
* Refactored working copy logic, so it's easier to add support for other
version control systems.
[fschulze]
* Added verbose flag to ``checkout`` and ``update`` commands.
[fschulze]
0.11 - 2009-04-06
-----------------
* Removed the nice os.path.relpath usage, because it's only been introduced
with Python 2.6.
[fschulze]
0.10 - 2009-04-06
-----------------
* Added verbose flag to ``status`` command.
[fschulze]
* Deprecated ``sources-svn`` and ``sources-git`` in favour of just ``sources``
which allows more flexibility.
[fschulze]
* Changed ``status`` command to only check known paths and not the whole
``sources-dir`` path.
[fschulze]
* Add possibility to filter packages in ``update`` and ``status`` commands.
[fschulze]
* Tell the user at the end of the buildout run whether there have been any
errors during automatic checkout.
[fschulze]
* Install the ``develop`` script as the first part instead of the last, so it
can be used to fix problems.
[fschulze]
0.9 - 2009-03-30
----------------
* When installed as just an egg, then the resulting ``develop`` script can be
called from anywhere and will try to find the correct ``develop`` script
from the current working directory and execute it.
[fschulze]
* Fixed help text formatting.
[fschulze]
0.8 - 2009-03-25
----------------
* Added authentication support to subversion commands.
[fschulze]
* Added ``-a`` option to ``checkout`` command to limit matching to the
packages declared by the ``auto-checkout`` option. If no further argument
is given, then all the packages from ``auto-checkout`` are processed.
[fschulze]
0.7 - 2009-03-24
----------------
* Added ``update`` command to ``checkout`` script.
[fschulze]
* Added ``status`` command to ``checkout`` script.
[fschulze]
* Added status flag to ``list`` command to indicate packages with wrong URL.
[fschulze]
* If the working copy is clean, then checkout automatically switches svn
packages.
[fschulze]
* Skip on checkout errors during buildout, so the develop script is generated
and you get a chance to inspect and fix the problems.
[fschulze]
* Check remote url and stop checkout if it differs.
[fschulze]
* Added various options to the ``list`` command.
[fschulze]
* Instead of the ``checkout`` script, there is now a ``develop`` script with
various commands.
[fschulze]
0.6 - 2009-03-24
----------------
* Added custom logging formatter for nicer output in the checkout script.
[fschulze]
* Removed the '-e' option, regular expression matching is the default now.
[fschulze]
* Made it possible to specify more than one regular expression without the
need to use a pipe symbol and quotes.
[fschulze]
* Added help text for the checkout script to pypi page.
[fschulze]
* Add a warning to rerun buildout after checkout.
[fschulze]
0.5 - 2009-03-23
----------------
* Make sure that the updated versions are actually used.
[fschulze]
0.4 - 2009-03-22
----------------
* Fixed logging, which fixes the info message output.
[fschulze]
* Skip checkout of existing packages.
[fschulze]
0.3 - 2009-03-22
----------------
* Fixed source distribution by adding a MANIFEST.in.
[fschulze]
* Added -e and -l options to checkout script.
[fschulze]
0.2 - 2009-03-22
----------------
* Added ``auto-checkout`` option (only works with subversion at the moment).
[fschulze]
* Added support for git.
[fschulze]
* Throw error when trying to checkout unknown package.
[fschulze]
* Fixed target directory for checkouts.
[fschulze]
0.1 - 2009-03-19
----------------
* Initial release
Raw data
{
"_id": null,
"home_page": "http://github.com/fschulze/mr.developer",
"name": "mr.developer",
"maintainer": null,
"docs_url": null,
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"maintainer_email": null,
"keywords": "buildout extension vcs git develop",
"author": "Florian Schulze",
"author_email": "florian.schulze@gmx.net",
"download_url": "https://files.pythonhosted.org/packages/e7/13/49fa149bfe94db61e86c16deaba8b9dcba6fe3d9965d30660844dfb7d3c4/mr.developer-2.0.2.tar.gz",
"platform": null,
"description": ".. contents:: :depth: 1\n\nIntroduction\n============\n\n.. figure:: https://fschulze.github.io/mr.developer/xkcd-buildout.png\n :figwidth: image\n\n Let Mr. Developer help you win the everlasting buildout battle!\n\n (Remixed by Matt Hamilton, original from https://xkcd.com/303)\n\n**mr.developer** is a `zc.buildout`_ extension that makes it easy to work with\nbuildouts containing lots of packages, of which you only want to develop some.\nThe basic idea comes from Wichert Akkerman's plonenext effort.\n\n.. _`zc.buildout`: https://pypi.org/project/zc.buildout/\n\n\nUsage\n=====\n\nAdd ``mr.developer`` to the ``extensions`` entry in your ``[buildout]``\nsection::\n\n [buildout]\n extensions = mr.developer\n\nThis enables additional ``[buildout]`` options:\n\n``sources``\n This specifies the name of a section which lists the repository\n information for your packages. Defaults to ``sources``.\n\n``sources-dir``\n This specifies the default directory where your development packages will\n be placed. Defaults to ``src``.\n\n``auto-checkout``\n This specifies the names of packages which should be checked out during\n buildout. Packages already checked out are skipped. You can use ``*`` as\n a wildcard for all packages in ``sources``.\n\n``always-checkout``\n This defaults to ``false``. If it's ``true``, then all packages specified\n by ``auto-checkout`` and currently in develop mode are updated during each\n buildout run. If set to ``force``, then packages are updated even when\n they are dirty instead of asking interactively.\n\n``update-git-submodules``\n This defaults to ``always``. If it's ``always``, then submodules present\n in each package in develompent will be registered and updated on checkout and\n new ones on updates via the develop command. If you don't want to initialize any submodule,\n set value to ``never``. If you set the value to ``checkout``,\n code inside submodules will be pulled only the first time, so the ``develop up`` command\n will leave the submodule empty. Note that update only initializes\n new submodules, it doesn't pull newest code from original submodule repo.\n\n``always-accept-server-certificate``\n This defaults to ``false``. If it's ``true``, invalid server\n certificates are accepted without asking (for subversion repositories).\n\n``mr.developer-threads``\n This sets the number of threads used for parallel checkouts. See\n `Lockups during checkouts and updates`_ why you might need this.\n\n``git-clone-depth``\n This sets the git clone history size (git clone --depth parameter).\n Not really useful for development, but really useful on CI environments.\n The other big benefit is the speedup on cloning,\n as only few revisions are downloaded.\n Default is to get the full history.\n\nThe format of entries in the ``[sources]`` section is::\n\n [sources]\n name = kind url [key=value ...]\n\nWhere individual parts are:\n\n``name``\n The package name.\n\n``kind``\n The kind of repository. Currently supported are ``svn``,\n ``hg``, ``git``, ``bzr``, ``darcs``, ``cvs``, or ``fs``.\n\n``url``\n The location of the repository. This value is specific to the version\n control system used.\n\n``key=value``\n You can add options for each individual package with this. No whitespace is\n allowed in ``key``, ``value``, and around the equal sign. For a\n description of the options see below. (*Note*: don't surround your ``key=value``\n with square brackets: we only use ``[ ]`` here to indicate that it\n is optional to add options.)\n\n\nThe per-package options are:\n\nCommon options\n The ``path`` option allows you to set the base directory where the\n package will be checked out. The name of the package will be appended to\n the base path. If ``path`` is not set, ``sources-dir`` is used.\n\n With ``full-path`` you can set the directory where the package will be\n checked out. This is the actual destination, nothing will be added. As\n an example::\n\n [sources]\n pkg = fs pkg full-path=/path/to/pkg\n\n The ``update`` option allows you to specify whether a package will be\n updated during buildout or not. If it's ``true``, then it will always be\n updated. If it's ``false``, then it will never be updated, even if the\n global ``always-checkout`` option is set.\n\n The ``egg`` option makes it possible to manage packages which are not\n eggs with ``egg=false``. All commands like ``update`` work as expected,\n but the package isn't added to the ``develop`` buildout option and the\n ``activate`` and ``deactivate`` commands skip the package.\n\n The ``newest_tag`` option allows you to checkout/update to the newest tag.\n Possible values of the option are \"true\" and \"false\".\n The ``newest_tag_prefix`` option allows you to limit the selection of tags to\n those which start with the prefix.\n These two options currently only work for ``cvs`` and ``hg``.\n\n``svn``\n The ``url`` is one of the urls supported by subversion.\n\n You can specify a url with a revision pin, like\n ``https://example.com/trunk@123``.\n\n You can also set the ``rev`` or ``revision`` option, which is either a pin\n like with ``rev=123`` or a minimum revision like ``rev=>123`` or\n ``rev=>=123``. When you set a minimum revision, the repository is updated\n when the current revision is lower.\n\n``git``\n The ``branch`` option allows you to use a specific branch instead of\n master.\n\n The ``rev`` option allows you to use a specific revision (usually a\n tag) instead of the HEAD.\n\n The ``pushurl`` options allows you to explicitly separate push url from pull\n url, configured by git config.\n\n The ``submodules`` option allows you to initialize existing submodules.\n Default value is controled by the buildout option ``update-git-submodules``.\n Possible values are the same described before in ``update-git-submodules`` option,\n\n The ``depth`` option allows to specify how much history you want to clone.\n This is the so called *shallow clones*.\n Note that this is mostly not useful at all for regular clones,\n on the other hand for one time usages (continuous integration for example) it makes clones much faster.\n This option overrides a general ``git-clone-depth`` value,\n so per-source depth can be specified.\n\n Note that the ``branch`` and ``rev`` option are mutually exclusive.\n\n``hg``\n The ``branch`` option allows you to use a specific branch instead of\n default.\n\n The ``rev`` option allows you to force a specific revision\n (hash, tag, branch) to be checked out after buildout\n\n``bzr``\n Currently no additional options.\n\n``darcs``\n Currently no additional options.\n\n``cvs``\n The ``cvs_root`` option can be used to override the setting of the $CVSROOT\n environment variable.\n The ``tag`` option forces checkout/update of the given tag instead of CVS\n HEAD.\n\n The ``tag_file`` option defines from which file tags will be read (in case of\n using ``newest_tag``). Default value is \"setup.py\".\n\n``fs``\n This allows you to add packages on the filesystem without a version\n control system, or with an unsupported one. You can activate and\n deactivate packages, but you don't get status info and can't update etc.\n\n The ``url`` needs to be the same as the ``name`` of the package.\n\nHere's an example of how your ``buildout.cfg`` may look like::\n\n [buildout]\n extensions = mr.developer\n auto-checkout = my.package\n\n [sources]\n my.package = svn https://example.com/svn/my.package/trunk update=true\n some.other.package = git git://example.com/git/some.other.package.git\n\nWhen you run buildout, the script ``bin/develop`` is created in your\nbuildout directory. With this script you can perform various actions on\npackages, like checking out their source code, without the need to know where\nthe repositories are located.\n\nFor help on what the script can do, run ``bin/develop help``.\n\nIf you checked out the source code of a package, you must run buildout again.\nThe new package will then be marked as a development egg and have its version\npin cleared (if any). You can control the list of development eggs explicitely\nwith the ``activate`` and ``deactivate`` commands.\n\nAny source where the path is a symlink is skipped during updates, as it is\nassumed, that the developer handles it manually. It is basically treated like\na filesystem source.\n\nConfiguration\n=============\n\nYou can add options to your global ``~/.buildout/mr.developer.cfg`` or local\n``.mr.developer-options.cfg`` in your buildout. Don't ever edit\n``.mr.developer.cfg`` in your buildout though, it's generated automatically.\n\nIn the ``[mr.developer]`` section you have the following options.\n\n``threads``\n This sets the number of threads used for parallel checkouts. See\n `Lockups during checkouts and updates`_ why you might need this.\n\nIn the ``[rewrites]`` section you can setup rewrite rules for sources. This is\nuseful if you want to provide a buildout with sources to repositories which have\ndifferent URLs for repositories which are read only for anonymous users. In that\ncase developers can add a URL rewrite which automatically changes the URL to a\nwritable repository.\n\nThe rewrite rules can have multiple operators:\n\n``=``\n Matches the exact string. Useful to only operated on sources of a certain kind\n and similar things. This doesn't rewrite anything, but limits the rule.\n\n``~=``\n Matches with a regular expression. This doesn't rewrite anything, but limits\n the rule.\n\n``~``\n This runs a regular expression substitution. The substitute is read from the\n next line. You can use groups in the expression and the backslash syntax in\n the substitute. See `re.sub`_ documentation.\n\n.. _`re.sub`: https://docs.python.org/3/library/re.html#re.sub\n\nThe following are useful examples::\n\n [rewrites]\n\n plone_svn =\n url ~ ^http://svn.plone.org/svn/\n https://svn.plone.org/svn/\n\n github =\n url ~ ^https://github.com/\n git@github.com:\n kind = git\n\n my_mrdeveloper_fork =\n url ~ fschulze(/mr.developer.git)\n me\\1\n\n my_mrdeveloper_fork_alternate =\n url ~= fschulze/mr.developer.git\n url ~ fschulze/\n me/\n\nExtending\n=========\n\nYou can extend mr.developer to teach it new types of Working Copies\nand to add or modify existing commands.\n\nMr.developer uses entrypoints for this. TO see examples on how to create entry\npoints in detail, you can have a look at the existing entry points.\n\nAdding support for a new working copy type\n------------------------------------------\nAdd en entry to the entry point group ``mr.developer.workingcopytypes``.\nThey key of the entry is going to be used in the sources section of your\nbuildout file. The value should be a class.\nThe referenced class must implement the following methods::\n\n - __init__(self, source)\n - matches(self)\n - checkout(self, **kwargs)\n - status(self, verbose=False, **kwargs)\n - update(self, **kwargs)\n\nThe source is a dictionary like object. The source object provides the\nattributes::\n\n - name\n - url\n - path\n\nIn addition it contains all key value pairs one can define on the source line\nin buildout, and a methods ``exists`` that returns, whether the ``path``\nalready exists.\n\nThe matches method must return, if the checkout at the ``path`` matches the\nrepository at ``url``\n\nThe commands map to the commands mr.developer provides. To see the list of\npotential arguments, check the documentation of the commands.\nThe commands ``checkout`` and update only return what they want to have printed\nout on stdout, the ``status`` command must check the verbose flag. If the\nverbose flag is set, it must return a tuple with what it wants to print out and\nwhat the VCS commands generated as output.\n\nAll objects must have list ``_output`` which contains logging information.\nPlease refer to existing implementations for how to fill this information.\n\nIf your working copy Handler needs to throw an error, throw errors with\n``mr.developer.common.WCError`` as a base clase.\n\nIf you need to add new functionality for new commands or change behavior of\nsomething, try not to write a new working copy handler. Try your best your\nchanges generically useful and get them into mr.developer.\n\nAdding a new command\n--------------------\nAdd an entry to the entry point group ``mr.developer.commands``.\nThe key will be the name of the command itself.\n\nThe referenced class must implement the following methods::\n\n - __init__(self, develop)\n - __call__(self, args)\n\nAn inversion of control happens here. On initalization, you receive a develop\nobject that represents the class handling invocation of ``./bin/develop``\nIt is now your job to modify the attributes of the ``develop`` object to handle\nargument parsing.\nCreate an ArgumentParser and add it to ``develop.parsers``.\n\nUpon calling, you can perform your actions. It is a good idea to subclass from\n``mr.developer.commands.Command``. It provides convenient helper methods::\n\n - get_workingcopies(self, sources)\n - get_packages(args, auto_checkout, develop, checked_out)\n\n``get_workingcopies`` gives you a WorkingCopies object that will delegate all\nyour working copy actions to the right working copy handler.\n\n``get_packages`` is a little helper to get sources filterd by the rules.\n``args`` can be one or more regular expression filtr on source names, the other\nattributes are boolean flags that by default are ``False``. False means _not_\nto filter. Calling the method only with the ``arg`` '.' would thus return all\npackges. THe returned object is a set containing only the names of the sources.\n\nTo perform an action, you get the package names via get_packages. then you get\nthe WorkingCopies object and call the action you want to perform on this\nobject. THe WorkingCopies object checks, which working copy is responsible for\nthe given package and delegates the action to this object. The WorkingCopies\nobject is also handling threading functionality.\n\nThe ``develop`` object has a ``config`` property. This object can be used to\nstore configuration of your actions. under ``config.develop`` a dictionary\nresides which stores, whether the source with the given key is going to be used\nfrom source checkout.\n\n\nTroubleshooting\n===============\n\nDirty SVN\n---------\n\nYou get an error like::\n\n ERROR: Can't switch package 'foo' to 'https://example.com/svn/foo/trunk/' because it's dirty.\n\nIf you have not modified the package files under src/foo, then you can check\nwhat's going on with ``status -v``. One common cause is a ``*.egg-info`` folder\nwhich gets generated every time you run buildout and this shows up as an\nuntracked item in svn status.\n\nYou should add .egg-info to your global Subversion ignores in\n``~/.subversion/config``, like this::\n\n global-ignores = *.o *.lo *.la *.al .libs *.so *.so.[0-9]* *.a *.pyc *.pyo *.rej *~ #*# .#* .*.swp .DS_Store *.egg-info\n\nHTTPS Certificates\n------------------\n\nThe best way to handle https certificates at the moment, is to accept them\npermanently when checking out the source manually.\n\nMercurial reports mismatching URL\n---------------------------------\n\nThis happens if you use lp:// URLs from launchpad. The problem is, that hg\nreports the actual URL, not the lp shortcut.\n\nLockups during checkouts and updates\n------------------------------------\n\nEspecially on multicore machines, there is an issue that you can get lockups\nbecause of the parallel checkouts. You can configure the number of threads used\nfor this in ``.mr.developer.cfg`` in the buildout root of your project or\nglobally in ``~/.buildout/mr.developer.cfg`` through the ``threads`` option\nin the ``[mr.developer]`` section or in your buildout in the ``buildout``\nsection with the ``mr.developer-threads`` option. Setting it to ``1`` should\nfix these issues, but this disables parallel checkouts and makes the process a\nbit slower.\n\nAlso, if you have `ControlPersist` in your local ssh config, and you\nhave a source checkout that uses ssh (for example\n``git@github.com:...``) the checkout or update may work fine, but the\nssh connection may stay open and ``mr.developer`` cannot exit because\nit waits for the ssh process to finish.\n\n\nCommands\n========\n\nThe following is a list of all commands and their options.\n\nactivate (a)\n------------\n\n::\n\n usage: develop activate [-h] [-a] [-c] [-d]\n package-regexp [package-regexp ...]\n \n Add packages to the list of development packages.\n \n positional arguments:\n package-regexp A regular expression to match package names.\n \n optional arguments:\n -h, --help show this help message and exit\n -a, --auto-checkout Only considers packages declared by auto-checkout. If\n you don't specify a <package-regexps> then all declared\n packages are processed.\n -c, --checked-out Only considers packages currently checked out. If you\n don't specify a <package-regexps> then all checked out\n packages are processed.\n -d, --develop Only considers packages currently in development mode.\n If you don't specify a <package-regexps> then all\n develop packages are processed.\n \n\narguments (args)\n----------------\n\n::\n\n usage: develop arguments [-h]\n \n Print arguments used by last buildout which will be used with the 'rebuild'\n command.\n \n optional arguments:\n -h, --help show this help message and exit\n \n\ncheckout (co)\n-------------\n\n::\n\n usage: develop checkout [-h] [-a] [-v] package-regexp [package-regexp ...]\n \n Make a checkout of the packages matching the regular expressions and add them\n to the list of development packages.\n \n positional arguments:\n package-regexp A regular expression to match package names.\n \n optional arguments:\n -h, --help show this help message and exit\n -a, --auto-checkout Only considers packages declared by auto-checkout. If\n you don't specify a <package-regexps> then all declared\n packages are processed.\n -v, --verbose Show output of VCS command.\n \n\ndeactivate (d)\n--------------\n\n::\n\n usage: develop deactivate [-h] [-a] [-c] [-d]\n package-regexp [package-regexp ...]\n \n Remove packages from the list of development packages.\n \n positional arguments:\n package-regexp A regular expression to match package names.\n \n optional arguments:\n -h, --help show this help message and exit\n -a, --auto-checkout Only considers packages declared by auto-checkout. If\n you don't specify a <package-regexps> then all declared\n packages are processed.\n -c, --checked-out Only considers packages currently checked out. If you\n don't specify a <package-regexps> then all checked out\n packages are processed.\n -d, --develop Only considers packages currently in development mode.\n If you don't specify a <package-regexps> then all\n develop packages are processed.\n \n\nhelp (h)\n--------\n\n::\n\n usage: develop help [-h] [--rst] [-z] [command]\n \n Show help on the given command or about the whole script if none given.\n \n positional arguments:\n command The command you want to see the help of.\n \n optional arguments:\n -h, --help show this help message and exit\n --rst Print help for all commands in reStructuredText format.\n -z, --zsh Print info for zsh autocompletion\n \n\ninfo\n----\n\n::\n\n usage: develop info [-h] [-a] [-c] [-d] [--name] [-p] [--type] [--url]\n [package-regexp [package-regexp ...]]\n \n Lists informations about packages.\n \n positional arguments:\n package-regexp A regular expression to match package names.\n \n optional arguments:\n -h, --help show this help message and exit\n -a, --auto-checkout Only considers packages declared by auto-checkout. If\n you don't specify a <package-regexps> then all declared\n packages are processed.\n -c, --checked-out Only considers packages currently checked out. If you\n don't specify a <package-regexps> then all declared\n packages are processed.\n -d, --develop Only considers packages currently in development mode.\n If you don't specify a <package-regexps> then all\n declared packages are processed.\n \n Output options:\n The following options are used to print just the info you want, the order\n they are specified reflects the order in which the information will be\n printed.\n \n --name Prints the name of the package.\n -p, --path Prints the absolute path of the package.\n --type Prints the repository type of the package.\n --url Prints the URL of the package.\n \n\nlist (ls)\n---------\n\n::\n\n usage: develop list [-h] [-a] [-c] [-d] [-l] [-s]\n [package-regexp [package-regexp ...]]\n \n Lists tracked packages.\n \n positional arguments:\n package-regexp A regular expression to match package names.\n \n optional arguments:\n -h, --help show this help message and exit\n -a, --auto-checkout Only show packages in auto-checkout list.\n -c, --checked-out Only considers packages currently checked out. If you\n don't specify a <package-regexps> then all checked out\n packages are processed.\n -d, --develop Only considers packages currently in development mode.\n If you don't specify a <package-regexps> then all\n develop packages are processed.\n -l, --long Show URL and kind of package.\n -s, --status Show checkout status.\n The first column in the output shows the checkout\n status:\n '#' available for checkout\n ' ' in auto-checkout list and checked out\n '~' not in auto-checkout list, but checked out\n '!' in auto-checkout list, but not checked out\n 'C' the repository URL doesn't match\n \n\npurge\n-----\n\n::\n\n usage: develop purge [-h] [-n] [-f] [package-regexp [package-regexp ...]]\n \n Remove checked out packages which aren't active anymore.\n \n Only 'svn' packages can be purged, because other repositories may contain\n unrecoverable files even when not marked as 'dirty'.\n \n positional arguments:\n package-regexp A regular expression to match package names.\n \n optional arguments:\n -h, --help show this help message and exit\n -n, --dry-run Don't actually remove anything, just print the paths which\n would be removed.\n -f, --force Force purge even if the working copy is dirty or unknown\n (non-svn).\n \n\nrebuild (rb)\n------------\n\n::\n\n usage: develop rebuild [-h] [-n]\n \n Run buildout with the last used arguments.\n \n optional arguments:\n -h, --help show this help message and exit\n -n, --dry-run DEPRECATED: Use 'arguments' command instead. Don't actually\n run buildout, just show the last used arguments.\n \n\nreset\n-----\n\n::\n\n usage: develop reset [-h] [-a] [-c] [-d] [package-regexp [package-regexp ...]]\n \n Resets the packages develop status. This is useful when switching to a new\n buildout configuration.\n \n positional arguments:\n package-regexp A regular expression to match package names.\n \n optional arguments:\n -h, --help show this help message and exit\n -a, --auto-checkout Only considers packages declared by auto-checkout. If\n you don't specify a <package-regexps> then all declared\n packages are processed.\n -c, --checked-out Only considers packages currently checked out. If you\n don't specify a <package-regexps> then all checked out\n packages are processed.\n -d, --develop Only considers packages currently in development mode.\n If you don't specify a <package-regexps> then all\n develop packages are processed.\n \n\nstatus (stat, st)\n-----------------\n\n::\n\n usage: develop status [-h] [-a] [-c] [-d] [-v]\n [package-regexp [package-regexp ...]]\n \n Shows the status of tracked packages, filtered if <package-regexps> is given.\n The first column in the output shows the checkout status:\n ' ' in auto-checkout list\n '~' not in auto-checkout list\n '!' in auto-checkout list, but not checked out\n 'C' the repository URL doesn't match\n '?' unknown package (only reported when package-regexp is not specified)\n The second column shows the working copy status:\n ' ' no changes\n 'M' local modifications or untracked files\n '>' your local branch is ahead of the remote one\n The third column shows the development status:\n ' ' activated\n '-' deactivated\n '!' deactivated, but the package is in the auto-checkout list\n 'A' activated, but not in list of development packages (run buildout)\n 'D' deactivated, but still in list of development packages (run buildout)\n \n positional arguments:\n package-regexp A regular expression to match package names.\n \n optional arguments:\n -h, --help show this help message and exit\n -a, --auto-checkout Only considers packages declared by auto-checkout. If\n you don't specify a <package-regexps> then all declared\n packages are processed.\n -c, --checked-out Only considers packages currently checked out. If you\n don't specify a <package-regexps> then all checked out\n packages are processed.\n -d, --develop Only considers packages currently in development mode.\n If you don't specify a <package-regexps> then all\n develop packages are processed.\n -v, --verbose Show output of VCS command.\n \n\nupdate (up)\n-----------\n\n::\n\n usage: develop update [-h] [-a] [-d] [-f] [-v]\n [package-regexp [package-regexp ...]]\n \n Updates all known packages currently checked out.\n \n positional arguments:\n package-regexp A regular expression to match package names.\n \n optional arguments:\n -h, --help show this help message and exit\n -a, --auto-checkout Only considers packages declared by auto-checkout. If\n you don't specify a <package-regexps> then all declared\n packages are processed.\n -d, --develop Only considers packages currently in development mode.\n If you don't specify a <package-regexps> then all\n develop packages are processed.\n -f, --force Force update even if the working copy is dirty.\n -v, --verbose Show output of VCS command.\n \n\n\n\nChangelog\n=========\n\n\n2.0.2 (2024-04-24)\n------------------\n\n* Fix ValueError: too many values to unpack (expected 2). [flipmcf]\n\n\n2.0.1 (2020-08-19)\n------------------\n\n* Fix ``bin/develop help`` on Python 3.\n\n\n2.0.0 (2019-03-04)\n------------------\n\n* Remove deprecated ``-n``/``--dry-run`` option from ``rebuild``/``rb`` command.\n [fschulze]\n\n* Use universal_newlines to deal with all output for git.\n [pbauer]\n\n* Fix verbose status in python 3.\n [pbauer]\n\n* Drop testing with Python 2.6 and Python 3.3, from now on there is no\n guarantee it will work with those Python versions.\n [fschulze]\n\n\n1.38 (2017-03-17)\n-----------------\n\n* Use ``from __future__ import print_function`` to fix output of ``help --rst``.\n [fschulze]\n\n* Set empty version pin for develop packages instead of removing the version\n pin from the section.\n [fschulze]\n\n\n1.37 (2017-03-04)\n-----------------\n\n* Add more info on git operations, so one can see which repository is cloned\n and which branch is used.\n [fschulze]\n\n* Fix git submodules with git 2.x.\n [fschulze]\n\n\n\n1.36 (2017-03-01)\n-----------------\n\n* Add the buildout option mr.developer-verbose that enables showing\n the same out when running buildout as when running ./bin/develop up -v.\n [sunew]\n\n* Respect the buildout -v setting for updates, just as it already does for checkouts.\n [sunew]\n\n\n1.35 - 2017-02-01\n-----------------\n\n* Do not use the backport of configparser on Python2, to fix\n \"Option values must be strings\" exception on some commands.\n [MatthewWilkes]\n\n* No longer test on Python 3.2. [maurits]\n\n* Improve error message when a directory isn't found in fs mode.\n [idgserpro]\n\n\n1.34 - 2015-09-30\n-----------------\n\n* Remove support for python 2.4 and 2.5. Use python 2.6 or higher or python\n 3.2 or higher.\n [reinout]\n\n* Report missing executables (like 'hg') instead of reporting a too-generic\n \"file not found\" error.\n [reinout]\n\n* Fix bug with assignments lacking the section. According to\n buildout's documentation ``option=value`` is equivalent to\n ``buildout:option=value``.\n Fixes issue #151\n [mvaled]\n\n* Fix switching to git branch from revision. When currently you are\n not on a git branch (for example on a tag), running a develop update\n would try to pull and fail. Now we simply fetch, and handle\n possible branch switching and merging the same as we always do.\n Fixes issue #162\n [maurits]\n\n* Fix unpinning of eggs with a name containing characters not in [^A-Za-z0-9.]\n This means that to correctly unpin pkg.foo_bar we have to delete\n ``pkg.foo-bar`` from the buildout ``[version]`` section.\n [ale-rt (Alessandro Pisa)]\n\n* Checkout branch when cloning a git repository.\n [gforcada]\n\n\n1.33 - 2015-05-25\n-----------------\n\n* Fix git-clone-depth global option, it needs to be kept as a string and not\n converted to a number.\n [gforcada, fschulze]\n\n\n1.32 - 2015-05-23\n-----------------\n\n* Add git-clone-depth global option and depth per source option to specify on\n git clones how much history wants to be cloned.\n [gforcada (Gil Forcada)]\n\n* Add plugin interface for adding commands using entry points.\n [fschulze]\n\n* Raise an exception if the sources section references a missing section.\n [icemac (Michael Howitz)]\n\n\n1.31 - 2014-10-29\n-----------------\n\n* Fixed submodule matching for some git versions.\n [jod (Josip Delic), fschulze]\n\n* Added compat.py for Python 3.\n [jod (Josip Delic)]\n\n* More info when svn cannot switch because of dirty checkout.\n [gotcha]\n\n* Git: try to switch to branch master when no branch has been\n specified. Do not give an error in this case when master is not\n there. Fixes issue #125\n [maurits]\n\n\n1.30 - 2014-03-14\n-----------------\n\n* Fix regression from 1.29.\n [Trii (Josh Johnston)]\n\n\n1.29 - 2014-03-14\n-----------------\n\n* Preserve order of eggs specified in ``develop`` option.\n [anjos (Andr\u00e9 Anjos)]\n\n\n1.28 - 2014-01-23\n-----------------\n\n* Mercurial now checks if working copy is ahead of remote branch.\n [rafaelbco]\n\n1.27 - 2014-01-10\n-----------------\n\n* Fix encoding issues during installation if the default encoding isn't\n properly set. Fixes issue #127\n [fschulze, jajadinimueter]\n\n* Fix error message when listing of git branches fails. Fixes issue #124\n [toutpt (JeanMichel FRANCOIS), fschulze]\n\n1.26 - 2013-09-10\n-----------------\n\n* Fixed branch option for git 1.6.0 until and including 1.6.2.\n Fixes issue #117.\n [maurits]\n\n* Skip update of symlinked sources.\n [chaoflow (Florian Friesdorf)]\n\n* Deprecate ``-n`` and ``--dry-run`` on ``rebuild`` command in favour of the\n new ``arguments`` command.\n\n1.25 - 2013-03-15\n-----------------\n\n* Git submodules support.\n [sunbit]\n\n* Added `newest_tag` option for mercurial and cvs.\n [kkujawinski, fschulze]\n\n* Python 3 fixes.\n [fschulze, jajadinimueter (Florian Mueller)]\n\n* Fix revision pinning. Refs #113\n [do3cc (Patrick Gerken)]\n\n* Properly line up the output of ``status``.\n [fschulze]\n\n1.24 - 2013-01-29\n-----------------\n\n* Mercurial now switches branches.\n [bubenkoff (Anatoly Bubenkov), fschulze]\n\n* Fix gitsvn/gitify working copy type which was broken since 1.22.\n [rpatterson (Ross Patterson)]\n\n* Fix deactivate command which was broken since 1.22. Refs #105\n [fschulze, icemac]\n\n1.23 - 2012-11-28\n-----------------\n\n* Unit tests run with Python 2.4, 2.5, 2.6, 2.7 and 3.2 now.\n [fschulze]\n\n* Officially added source rewrites. Refs #56\n [fschulze]\n\n* Add additional optional config file ``.mr.developer-options.cfg`` which is\n read from the buildout directory for local version controllable options.\n [fschulze]\n\n* Update all activated packages during buildout if ``always-checkout`` is true\n instead of only the ones in the ``auto-checkout`` list or with the ``update``\n option set. Refs #95\n [fschulze]\n\n* Fix asking for password for svn with basic authentication. Refs #100\n [MordicusEtCubitus]\n\n* Fixed regressions in svn module. Refs #37\n [fschulze, evilbungle (Alan Hoey)]\n\n* Fixed branch checkout for git on Python 3.\n [mitchellrj]\n\n* Fixed subversion checkout on Python 3.\n [mitchellrj]\n\n1.22 - 2012-10-13\n-----------------\n\n* If you set threads to 1, then we don't use any separate thread anymore, the\n actions are now done in the main thread.\n [fschulze]\n\n* Allow configuration of the number of threads used through the buildout config\n by setting the ``mr.developer-threads`` option in the ``buildout`` section.\n [fschulze]\n\n* For git repositories the ``status`` command shows you when your local branch\n is ahead of the remote branch.\n [fschulze]\n\n* Always make ``sources-dir`` option available in buildout, even if it's set\n to the default. Fixes #49\n [fschulze]\n\n* Parse revision from url for all svn commands. Fixes #37\n [fschulze]\n\n* Use entry points to allow adding and overwriting working copy types via\n addon packages.\n [fschulze]\n\n* Fixed ValueError in verbose status for filesystem and gitsvn sources.\n [maurits]\n\n* Fixed some exceptions occurring when using with Python 3.\n [icemac (Michael Howitz)]\n\n* On Windows, use the PATHEXT environment variable to find the git executable.\n [kleist]\n\n1.21 - 2012-04-11\n-----------------\n\n* Added ``threads`` option to ``[mr.developer]`` section to set number of\n threads used for running checkouts.\n [fschulze]\n\n* Read a per user config file from ~/.buildout/mr.developer.cfg in addition to\n the regular .mr.developer.cfg in the current buildout base.\n [fschulze]\n\n* Python 3 support by using 2to3.\n [mitchellrj (Richard Mitchell)]\n\n1.20 - 2012-02-26\n-----------------\n\n* Git: Added ``pushurl`` option\n [iElectric (Domen Ko\u017ear)]\n\n* Refactored thread locking.\n [shywolf9982]\n\n* Refactored search for git executable and version handling.\n [shywolf9982]\n\n* In the status command report unknown packages with '?' when no\n package-regexp has been given.\n [maurits]\n\n* Added --force option to purge command. Especially helpful in\n purging non-subversion packages, which otherwise we refuse to\n remove. Fixes issue #71.\n [maurits]\n\n* Do not depend on `elementtree` if there is `xml.etree` (Python >= 2.5).\n\n* Don't set locale anymore when calling ``svn``. This may break if the output\n is localized instead of english, I couldn't reproduce that anymore though.\n [fschulze, rochecompaan (Roch\u00e9 Compaan)]\n\n* Fix compatibility with mercurial v2.1\n [janjaapdriessen (Jan-Jaap Driessen)].\n\n1.19 - 2011-09-22\n-----------------\n\n* Git: Don't stop buildout after renaming/adding git remotes, i.e. when\n actively working on a given package.\n [witsch (Andreas Zeidler)]\n\n* Bugfix: Honhour buildout:develop parameters even if ending with slash.\n [lukenowak]\n\n* Installation: Check presence of required modules instead of relying on\n version of python.\n [lukenowak (\u0141ukasz Nowak)]\n\n1.18 - 2011-08-16\n-----------------\n\n* Mercurial: Added support for branches.\n [posborne (Paul Osborne)]\n\n* Git: Added support for the Windows msysGit.\n [canassa (Cesar Canassa)]\n\n* Git: Added ``rev`` option that allows you to use a specific revision\n (usually a tag) instead of the HEAD.\n [maurits (Maurits van Rees)]\n\n1.17 - 2011-01-26\n-----------------\n\n* Git: Default to branch ``master`` if no branch is given in the source.\n [stefan]\n\n* Brush up the README.\n [stefan]\n\n* Create the sources-dir if it is not present.\n [janjaapdriessen]\n\n* Only require argparse with Python < 2.7.\n [dobe]\n\n* Fixed issue #35 using bzr, similar to the fix #28 for hg in last version.\n [menesis]\n\n* Pass branch to bzr pull.\n [menesis]\n\n* Add support for darcs.\n [lelit, azazel]\n\n1.16 - 2010-09-16\n-----------------\n\n* Fix ``NameError: global name 'source' is not defined`` when using gitsvn\n and running ``status`` command.\n [markvl]\n\n* Add handling of new ``-s`` command line option of zc.buildout 1.5, this\n fixes issue #29.\n [fschulze]\n\n* Don't pass the PYTHONPATH onwards to mercurial, this fixes issue #28\n [fschulze, Christian Zagrodnick]\n\n* Fix saving buildout options on Windows. Issue #24\n [fschulze]\n\n* Only warn if the svn version is too old.\n [fschulze]\n\n1.15 - 2010-07-25\n-----------------\n\n* Use ``always-checkout`` option from buildout config for ``update`` command.\n This fixes issue #18.\n [fschulze]\n\n* Fix ``OSError: [Errno 10] No child processes`` errors in Python 2.4 and 2.5.\n (Issue #12)\n [fschulze]\n\n* Fix CVS update.\n [sargo]\n\n1.14 - 2010-05-15\n-----------------\n\n* Added bzr support.\n [tseaver]\n\n* Added git branch support.\n [shywolf9982, fschulze]\n\n1.13 - 2010-04-11\n-----------------\n\n* Tell the user which packages are queued for update or checkout, so one can\n check which packages are still updating now that the output is only printed\n after everything is done due to parallel checkouts.\n [fschulze]\n\n* Added ``always-accept-server-certificate`` option. When set in the\n ``[buildout]`` section, then invalid certificates are always accepted for\n subversion repositories.\n [fschulze]\n\n* Added ``-v``/``--version`` option.\n [tomster, fschulze]\n\n* Use the much nicer argparse library instead of optparse.\n [fschulze]\n\n1.12 - 2010-03-15\n-----------------\n\n* Fix svn checkout.\n [fschulze]\n\n1.11 - 2010-03-14\n-----------------\n\n* Handle untrusted server certificates by asking the user what to do.\n [fschulze]\n\n* Properly handle user input for authorization by using locks to prevent\n problems with parallel checkouts.\n [fschulze]\n\n* Only checkout/update packages in auto-checkout or with ``update = true``\n option when running buildout.\n [fschulze]\n\n1.10 - 2010-02-06\n-----------------\n\n* Don't store the buildout options if they contain a command.\n [fschulze]\n\n* Basic support for buildout offline mode (-o). Not all cases are handled yet.\n [fschulze]\n\n* Added ``full-path`` package option.\n [fschulze]\n\n* Added ``egg`` package option (Issue #6).\n [fschulze]\n\n* By setting ``always-checkout = force``, all packages will be updated\n without asking when dirty.\n [fschulze]\n\n* The ``[path]`` part of sources is replaced by ``path=PATH`` syntax and\n throws a warning when used.\n [fschulze]\n\n* Per package options are now allowed before the URL.\n [fschulze]\n\n* Check ``svn`` version and output helpful error messages if it's too old or\n can't be determined (Issue #13).\n [fschulze]\n\n* Error messages instead of tracebacks when source definitions are wrong.\n [fschulze]\n\n* Fix checkout of packages (Issues #9 and #11).\n [fschulze]\n\n* Possibility to checkout/update tags instead of HEAD in CVS\n [sargo]\n\n* Tests for CVS integration\n [sargo]\n\n* Better checking of CVS package purity.\n [sargo]\n\n1.9 - 2010-01-11\n----------------\n\n* Added dry-run option to ``purge`` command.\n [fschulze]\n\n* Fix purging on windows.\n [kleist (Karl Johan Kleist)]\n\n* Fix compatibility with Python < 2.6.\n [fschulze, vincentfretin]\n\n* Fix `all` answer for ``update`` command.\n [fschulze]\n\n1.8 - 2010-01-10\n----------------\n\n* Added threading for parallel checkouts.\n [fschulze, jensens]\n\n* Ask whether to update dirty packages during checkout.\n [fschulze]\n\n* When you answered `yes` when asked whether to update a dirty package, then\n all further questions had been answered with `yes` as well, this is now\n fixed.\n [fschulze]\n\n* Added `all` option when asked to update dirty packages.\n [fschulze]\n\n* Added help for all commands to PyPI description.\n [fschulze]\n\n* Added option to ``help`` command which outputs the help for all commands in\n reStructuredText format.\n [fschulze]\n\n* Don't abort after user answered `no` on whether to update a package, just\n skip that package.\n [fschulze]\n\n1.7 - 2009-11-26\n----------------\n\n* Fix a problem where a package wasn't added to the develop packages on auto\n checkout.\n [fschulze]\n\n1.6 - 2009-11-21\n----------------\n\n* Filter the packages gathered from ``buildout:develop`` to ones declared in\n sources, otherwise things like \"develop = .\" break.\n [fschulze]\n\n* Added support for Concurrent Versions System (CVS).\n [sargo (Wojciech Lichota)]\n\n1.5 - 2009-11-19\n----------------\n\n* Added global ``always-checkout`` and a per source ``update`` option.\n [fschulze]\n\n* Added ``purge`` command.\n [fschulze]\n\n* Ask user how to proceed when package is dirty.\n [fschulze]\n\n* Refactored package matching and made the command options consistent.\n Now you can update only the packages currently in development with ``-d``\n and similar possibilities.\n [fschulze]\n\n* Fix duplicate logging output.\n [fschulze]\n\n* Fix parsing of buildout arguments when ``-t`` was used.\n [fschulze]\n\n1.4 - 2009-11-16\n----------------\n\n* Allow to set a minimal revision for ``svn`` repositories. If the current\n revision is lower, then the package is updated.\n [fschulze]\n\n1.3 - 2009-11-15\n----------------\n\n* Read the cfg used by last buildout run. This prevents unexpected behaviour,\n if you change mr.developer options like source declarations and don't run\n buildout. Such changes are now picked up immediately.\n [fschulze]\n\n* Added tests and a buildout to run them easily.\n [fschulze]\n\n1.2 - 2009-11-12\n----------------\n\n* If a package is removed from ``auto-checkout`` and wasn't explicitly\n activated, then it will be removed from the develop packages automatically.\n In existing buildouts with an older mr.developer, you have to ``reset`` the\n packages first.\n [fschulze]\n\n* Added ``*`` wild card support for ``auto-checkout``.\n [fschulze]\n\n* Don't bail on subversion URLs ending in a slash or a revision marker.\n [fschulze]\n\n* Removed old way of specifying sources with ``sources-svn`` and\n ``sources-git``.\n [fschulze]\n\n* Exit immediately when there are issues during checkout when running as\n extension.\n [fschulze]\n\n* Use verbosity from buildout when running as extension.\n [fschulze]\n\n* Fix buildout_dir in ``develop`` script, so it is properly escaped on\n Windows.\n [fschulze]\n\n* Changed the output of ``list -s`` to match the one from ``status``.\n [fschulze]\n\n* Added troubleshooting section to readme.\n [miohtama, fschulze]\n\n* All commands have a ``-h`` and ``--help`` option now to show their help.\n [fschulze]\n\n1.1 - 2009-08-07\n----------------\n\n* Use relative paths from the buildout directory for the ``develop`` option\n if possible. This fixes issues if your buildout path contains a space.\n [fschulze]\n\n* Warn when trying to activate or deactivate a package which isn't checked out.\n [fschulze]\n\n* Don't depend on elementree on Python >= 2.5, because it's builtin there.\n [fschulze]\n\n* When checking out a source it will automatically be activated.\n [fschulze]\n\n* Use 'sources' as the default section name for source information.\n [fschulze]\n\n* Added support for filesystem packages without version control with the\n 'fs' type.\n [fschulze]\n\n1.0.1 - 2009-05-05\n------------------\n\n* Fixed case sensitivity of package names for several commands.\n [fschulze]\n\n* SVN externals no longer cause a modified status.\n [fschulze]\n\n1.0 - 2009-05-02\n----------------\n\n* Added ``info`` command to print various informations about packages.\n [fschulze]\n\n* Added ``reset`` command to reset the develop state of packages. This is\n useful when switching to a new buildout configuration. During the next\n buildout run the develop state is determined the same way as in a clean\n buildout.\n [fschulze]\n\n* Got rid of deprecation warning in Python 2.6 by removing unnecessary call\n of __init__ in working copy implementations.\n [fschulze]\n\n0.15 - 2009-04-17\n-----------------\n\n* Added reminder to run buildout after activating or deactivating packages.\n [fschulze]\n\n* Added ``rebuild`` command to rerun buildout with the last used arguments.\n [fschulze]\n\n0.14 - 2009-04-16\n-----------------\n\n* Fixed verbose output of ``checkout`` command.\n [fschulze]\n\n* Added ``-f`` option to ``update`` command to force updates even if the\n working copy is dirty.\n [fschulze]\n\n0.13 - 2009-04-14\n-----------------\n\n* Added ``-a`` option to ``update`` command to only update the packages\n declared in the ``auto-checkout`` list.\n [fschulze]\n\n* Added ``activate`` and ``deactivate`` commands. This allows to select which\n packages are added to the ``develop`` option of zc.buildout. Enhanced the\n ``status`` command to show the additional informations.\n [fschulze]\n\n* Switched the meaning of ``~`` and ``C`` in status command.\n [fschulze]\n\n0.12 - 2009-04-14\n-----------------\n\n* Added support for Mercurial (hg).\n [mj]\n\n* Refactored working copy logic, so it's easier to add support for other\n version control systems.\n [fschulze]\n\n* Added verbose flag to ``checkout`` and ``update`` commands.\n [fschulze]\n\n0.11 - 2009-04-06\n-----------------\n\n* Removed the nice os.path.relpath usage, because it's only been introduced\n with Python 2.6.\n [fschulze]\n\n0.10 - 2009-04-06\n-----------------\n\n* Added verbose flag to ``status`` command.\n [fschulze]\n\n* Deprecated ``sources-svn`` and ``sources-git`` in favour of just ``sources``\n which allows more flexibility.\n [fschulze]\n\n* Changed ``status`` command to only check known paths and not the whole\n ``sources-dir`` path.\n [fschulze]\n\n* Add possibility to filter packages in ``update`` and ``status`` commands.\n [fschulze]\n\n* Tell the user at the end of the buildout run whether there have been any\n errors during automatic checkout.\n [fschulze]\n\n* Install the ``develop`` script as the first part instead of the last, so it\n can be used to fix problems.\n [fschulze]\n\n0.9 - 2009-03-30\n----------------\n\n* When installed as just an egg, then the resulting ``develop`` script can be\n called from anywhere and will try to find the correct ``develop`` script\n from the current working directory and execute it.\n [fschulze]\n\n* Fixed help text formatting.\n [fschulze]\n\n0.8 - 2009-03-25\n----------------\n\n* Added authentication support to subversion commands.\n [fschulze]\n\n* Added ``-a`` option to ``checkout`` command to limit matching to the\n packages declared by the ``auto-checkout`` option. If no further argument\n is given, then all the packages from ``auto-checkout`` are processed.\n [fschulze]\n\n0.7 - 2009-03-24\n----------------\n\n* Added ``update`` command to ``checkout`` script.\n [fschulze]\n\n* Added ``status`` command to ``checkout`` script.\n [fschulze]\n\n* Added status flag to ``list`` command to indicate packages with wrong URL.\n [fschulze]\n\n* If the working copy is clean, then checkout automatically switches svn\n packages.\n [fschulze]\n\n* Skip on checkout errors during buildout, so the develop script is generated\n and you get a chance to inspect and fix the problems.\n [fschulze]\n\n* Check remote url and stop checkout if it differs.\n [fschulze]\n\n* Added various options to the ``list`` command.\n [fschulze]\n\n* Instead of the ``checkout`` script, there is now a ``develop`` script with\n various commands.\n [fschulze]\n\n0.6 - 2009-03-24\n----------------\n\n* Added custom logging formatter for nicer output in the checkout script.\n [fschulze]\n\n* Removed the '-e' option, regular expression matching is the default now.\n [fschulze]\n\n* Made it possible to specify more than one regular expression without the\n need to use a pipe symbol and quotes.\n [fschulze]\n\n* Added help text for the checkout script to pypi page.\n [fschulze]\n\n* Add a warning to rerun buildout after checkout.\n [fschulze]\n\n0.5 - 2009-03-23\n----------------\n\n* Make sure that the updated versions are actually used.\n [fschulze]\n\n0.4 - 2009-03-22\n----------------\n\n* Fixed logging, which fixes the info message output.\n [fschulze]\n\n* Skip checkout of existing packages.\n [fschulze]\n\n0.3 - 2009-03-22\n----------------\n\n* Fixed source distribution by adding a MANIFEST.in.\n [fschulze]\n\n* Added -e and -l options to checkout script.\n [fschulze]\n\n0.2 - 2009-03-22\n----------------\n\n* Added ``auto-checkout`` option (only works with subversion at the moment).\n [fschulze]\n\n* Added support for git.\n [fschulze]\n\n* Throw error when trying to checkout unknown package.\n [fschulze]\n\n* Fixed target directory for checkouts.\n [fschulze]\n\n0.1 - 2009-03-19\n----------------\n\n* Initial release\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "A zc.buildout extension to ease the development of large projects with lots of packages.",
"version": "2.0.2",
"project_urls": {
"Homepage": "http://github.com/fschulze/mr.developer"
},
"split_keywords": [
"buildout",
"extension",
"vcs",
"git",
"develop"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f208c59a742307ecdaeaaec8697b26c522d90339d28264833bfa56f7f439a2e1",
"md5": "ac3410580930292b410139a5da05aecb",
"sha256": "3a502b5ae07a814dedfed53f8bc5afbafa387342865eb5730197c402b67378eb"
},
"downloads": -1,
"filename": "mr.developer-2.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac3410580930292b410139a5da05aecb",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"size": 60924,
"upload_time": "2024-04-24T19:50:10",
"upload_time_iso_8601": "2024-04-24T19:50:10.579787Z",
"url": "https://files.pythonhosted.org/packages/f2/08/c59a742307ecdaeaaec8697b26c522d90339d28264833bfa56f7f439a2e1/mr.developer-2.0.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e71349fa149bfe94db61e86c16deaba8b9dcba6fe3d9965d30660844dfb7d3c4",
"md5": "109ae2bd551c20c1cc292c7bae6e3dc8",
"sha256": "4a0ef4f2fb3aa19cf96a8fb576c00f71e33f625eb82667188c0818f1587957d8"
},
"downloads": -1,
"filename": "mr.developer-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "109ae2bd551c20c1cc292c7bae6e3dc8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"size": 78702,
"upload_time": "2024-04-24T19:50:13",
"upload_time_iso_8601": "2024-04-24T19:50:13.485807Z",
"url": "https://files.pythonhosted.org/packages/e7/13/49fa149bfe94db61e86c16deaba8b9dcba6fe3d9965d30660844dfb7d3c4/mr.developer-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 19:50:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fschulze",
"github_project": "mr.developer",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "mr.developer"
}
JSON
