virtualenvwrapper.bitbucket 1.2¶

virtualenvwrapper.bitbucket is a template for virtualenvwrapper to extend its project-management features. It automatically clones a BitBucket repository when creating a new project directory.

Example¶

$ mkproject -t bitbucket virtualenvwrapper.bitbucket
New python executable in virtualenvwrapper.bitbucket/bin/python
Installing distribute.............................................
..................................................................
..................................................................
virtualenvwrapper.user_scripts Creating /Users/dhellmann/.virtualenvs/virtualenvwrapper.bitbucket/bin/predeactivate
virtualenvwrapper.user_scripts Creating /Users/dhellmann/.virtualenvs/virtualenvwrapper.bitbucket/bin/postdeactivate
virtualenvwrapper.user_scripts Creating /Users/dhellmann/.virtualenvs/virtualenvwrapper.bitbucket/bin/preactivate
virtualenvwrapper.user_scripts Creating /Users/dhellmann/.virtualenvs/virtualenvwrapper.bitbucket/bin/postactivate

Creating /Users/dhellmann/Devel/virtualenvwrapper.bitbucket
Applying template bitbucket
virtualenvwrapper.bitbucket Cloning ssh://hg@bitbucket.org/dhellmann/virtualenvwrapper.bitbucket
requesting all changes
adding changesets
adding manifests
adding file changes
added 3 changesets with 10 changes to 8 files
updating to branch default
8 files updated, 0 files merged, 0 files removed, 0 files unresolved
(virtualenvwrapper.bitbucket) $ ls
virtualenvwrapper.bitbucket
(virtualenvwrapper.bitbucket) $ cat virtualenvwrapper.bitbucket/.hg/hgrc
[paths]
default = ssh://hg@bitbucket.org/dhellmann/virtualenvwrapper.bitbucket

Details¶

Installation¶

Basic Installation¶

virtualenvwrapper.bitbucket should be installed using pip:

$ pip install virtualenvwrapper.bitbucket

You will want to install it into the same Python site-packages area where virtualenv, virtualenvwrapper, and virtualenvwrapper.project are located. You may need administrative privileges to do that. Refer to the virtualenvwrapper documentation for configuration instructions for virtualenvwrapper.

VIRTUALENVWRAPPER_BITBUCKET_USER¶

The variable VIRTUALENVWRAPPER_BITBUCKET_USER tells virtualenvwrapper.bitbucket what username to use when connecting to BitBucket. The default is to use the name of the current system user ($USER).

If your local system user and BitBucket account name are not the same, you will want to add a line like:

export VIRTUALENVWRAPPER_BITBUCKET_USER=username

to your shell startup file.

For Developers¶

If you would like to contribute to virtualenvwrapper.bitbucket directly, these instructions should help you get started. Patches, bug reports, and feature requests are all welcome through the BitBucket project site. Contributions in the form of patches or pull requests are easier to integrate and will receive priority attention.

Building Documentation¶

The documentation for virtualenvwrapper.bitbucket is written in reStructuredText and converted to HTML using Sphinx. The build itself is driven by make. You will need the following packages in order to build the docs:

Sphinx
docutils

Once all of the tools are installed into a virtualenv using pip, run make html to generate the HTML version of the documentation.

Running Tests¶

The test suite for virtualenvwrapper.bitbucket uses shunit2 and tox. To run the tests under bash, sh, and zsh, run tox from the top of the source tree. To add new tests, modify or create an appropriate script in the tests directory.

Release History¶

1.2

Repackaged the documentation

Updated the installation requirements to look for virtualenvwrapper >= 2.9.

1.1

Change the local name for the source directory to match the project directory name instead of always using “src”.

1.0

First public release.

License¶

Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Doug Hellmann not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission.

DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.