Commit 6765d2e6 authored by Jan Dittberner's avatar Jan Dittberner

Imported Upstream version 4.1.1

parent c91533db
syntax: glob
*~
*.pyc
README.html
build
dist
distribute*.egg
distribute*.tar.gz
docs/build
docs/html
docs/website
docs/en
docs/es
docs/ja
tests/catch_output
tests/testpackage/build
tests/testpackage/dist
tests/testpackage/testpackage.egg-info
tests/testtemplate/build
tests/testtemplate/dist
tests/testtemplate/testtemplate.egg-info
trace.txt
virtualenvwrapper.egg-info
virtualenvwrapper/docs
.tox
*.orig
TAGS
ChangeLog
AUTHORS
syntax: re
.DS_Store
^web/
Copyright Doug Hellmann, All Rights Reserved
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.
include setup.py
include distribute_setup.py
include tests/*
include tests/testpackage/setup.py
include tests/testpackage/testscript.py
include tests/testtemplate/distribute_setup.py
include tests/testtemplate/setup.py
include tests/testtemplate/mytemplates/*.py
recursive-include docs *.rst *.py *.html *.css *.js *.png *.txt
include tox.ini
# Default target is to show help
help:
@echo "sdist - Source distribution"
@echo "html - HTML documentation"
@echo "docclean - Remove documentation build files"
@echo "upload - upload a new release to PyPI"
@echo "develop - install development version"
@echo "test - run the test suite"
@echo "test-quick - run the test suite for bash and one version of Python ($(PYTHON26))"
.PHONY: sdist
sdist: html
rm -f dist/*.gz
rm -rf docs/website
python setup.py sdist
cp -v dist/*.gz ~/Desktop
# Documentation
.PHONY: html
html:
(cd docs && $(MAKE) html)
.PHONY: docclean
docclean:
rm -rf docs/build docs/html
# Register the new version on pypi
.PHONY: register
register:
echo "USE upload target"
exit 1
python setup.py register
.PHONY: upload
upload:
python setup.py sdist upload
# Testing
test:
tox
test-quick:
tox -e py27
develop:
python setup.py develop
Metadata-Version: 1.1
Name: virtualenvwrapper
Version: 3.4
Version: 4.1.1
Summary: Enhancements to virtualenv
Home-page: http://www.doughellmann.com/projects/virtualenvwrapper/
Home-page: http://virtualenvwrapper.readthedocs.org/
Author: Doug Hellmann
Author-email: doug.hellmann@gmail.com
License: UNKNOWN
License: MIT
Description: .. -*- mode: rst -*-
#################
......@@ -19,6 +19,13 @@ Description: .. -*- mode: rst -*-
than one project at a time without introducing conflicts in their
dependencies.
**Warning:** The 4.x release includes some potentially incompatible
changes for extensions from 3.x. The python modules for extensions are
now *always* run with ``PWD=$WORKON_HOME`` (previously the value of
PWD varied depending on the hook). The *shell* portion of any hook
(anything sourced by the user's shell when the hook is run) is still
run in the same place as before.
========
Features
========
......@@ -38,7 +45,7 @@ Description: .. -*- mode: rst -*-
6. Plugin system for more creating sharable extensions.
Rich Leland has created a short `screencast
<http://mathematism.com/2009/jul/30/presentation-pip-and-virtualenv/>`__
<http://mathematism.com/2009/07/30/presentation-pip-and-virtualenv/>`__
showing off the features of virtualenvwrapper.
============
......@@ -53,7 +60,7 @@ Description: .. -*- mode: rst -*-
================
virtualenvwrapper is a set of shell *functions* defined in Bourne
shell compatible syntax. It is tested under `bash`, `ksh`, and `zsh`.
shell compatible syntax. It is tested under ``bash``, ``ksh``, and ``zsh``.
It may work with other shells, so if you find that it does work with a
shell not listed here please let me know. If you can modify it to
work with another shell, without completely rewriting it, send a pull
......@@ -64,34 +71,7 @@ Description: .. -*- mode: rst -*-
Python Versions
===============
virtualenvwrapper is tested under Python 2.4 - 2.7.
Upgrading to 2.9
================
Version 2.9 includes the features previously delivered separately by
``virtualenvwrapper.project``. If you have an older verison of the
project extensions installed, remove them before upgrading.
Upgrading from 1.x
==================
The shell script containing the wrapper functions has been renamed in
the 2.x series to reflect the fact that shells other than bash are
supported. In your startup file, change ``source
/usr/local/bin/virtualenvwrapper_bashrc`` to ``source
/usr/local/bin/virtualenvwrapper.sh``.
============
Contributing
============
Before contributing new features to virtualenvwrapper core, consider
whether they should be implemented as an extension instead.
Refer to the `developers docs
<http://www.doughellmann.com/docs/virtualenvwrapper/developers.html>`__
for tips on contributing patches.
virtualenvwrapper is tested under Python 2.6 - 3.3.
=======
Support
......@@ -144,7 +124,9 @@ Description: .. -*- mode: rst -*-
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
Platform: Any
Keywords: virtualenv
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
......@@ -153,6 +135,7 @@ Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Provides: virtualenvwrapper
......
.. -*- mode: rst -*-
#################
virtualenvwrapper
#################
virtualenvwrapper es un conjunto de extensiones de la herramienta de Ian
Bicking `virtualenv <http://pypi.python.org/pypi/virtualenv>`_. Las extensiones
incluyen funciones para la creación y eliminación de entornos virtuales y por otro
lado administración de tu rutina de desarrollo, haciendo fácil trabajar en más
de un proyecto al mismo tiempo sin introducir conflictos entre sus dependencias.
===============
Características
===============
1. Organiza todos tus entornos virtuales en un sólo lugar.
2. Funciones para administrar tus entornos virtuales (crear, eliminar, copiar).
3. Usa un sólo comando para cambiar entre los entornos.
4. Completa con Tab los comandos que toman un entorno virtual como argumento.
5. Ganchos configurables para todas las operaciones.
6. Sistema de plugins para la creación de extensiones compartibles.
Rich Leland ha grabado un pequeño `screencast
<http://mathematism.com/2009/07/30/presentation-pip-and-virtualenv/>`__
mostrando las características de virtualenvwrapper.
===========
Instalación
===========
Ve a la `documentación del proyecto <http://www.doughellmann.com/docs/virtualenvwrapper/>`__
para las instrucciones de instalación y configuración.
Actualizar desde 1.x
====================
El script de shell que contiene las funciones ha sido renombrado en la serie
2.x para reflejar el hecho de que otros shells, además de bash, son soportados. En
tu archivo de inicio del shell, cambia ``source
/usr/local/bin/virtualenvwrapper_bashrc`` por ``source
/usr/local/bin/virtualenvwrapper.sh``.
==============
Contribuciones
==============
Antes de contribuir con nuevas características al *core* de virtualenvwrapper,
por favor considera, en vez, si no debe ser implementada como una extensión.
Ve a la `documentación para desarrolladores
<http://www.doughellmann.com/docs/virtualenvwrapper/developers.html>`__
por trucos sobre parches.
========
Licencia
========
Copyright Doug Hellmann, All Rights Reserved
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.
.. _BitBucket: http://bitbucket.org/dhellmann/virtualenvwrapper/overview/
.. -*- mode: rst -*-
#################
virtualenvwrapper
#################
virtualenvwrapper は Ian Bicking の
`virtualenv <http://pypi.python.org/pypi/virtualenv>`_ ツールの
拡張機能です。この拡張機能は仮想環境の作成・削除を行ったり、
開発ワークフローを管理するラッパーを提供します。このラッパーを
使用することで、開発環境の依存による競合を発生させず、1つ以上の
プロジェクトで同時に作業し易くなります。
====
機能
====
1. 1つの開発環境で全ての仮想環境を構成する
2. 仮想環境を管理(作成、削除、コピー)するラッパー
3. たった1つのコマンドで仮想環境を切り替える
4. コマンドの引数として仮想環境がタブ補完できる
5. 全ての操作に対してユーザ設定でフックできる(:ref:`scripts` を参照)
6. さらに共有可能な拡張機能を作成できるプラグインシステム(:ref:`plugins` を参照)
Rich Leland は virtualenvwrapper の機能を誇示するために短い
`スクリーンキャスト <http://mathematism.com/2009/07/30/presentation-pip-and-virtualenv/>`__
を作成しました。
============
インストール
============
インストールとインフラを設定するには
`プロジェクトのドキュメント <http://www.doughellmann.com/docs/virtualenvwrapper/ja/>`__
を参照してください。
サポートシェル
==============
virtualenvwrapper は Bourne シェル互換の構文で定義された
シェル *関数* のセットです。それは `bash`, `ksh` と `zsh` で
テストされています。その他のシェルでも動作するかもしれませんが、
ここに記載されていないシェルで動作することを発見したら私に
教えてください。もしあなたがその他のシェルで動作させるために
virtualenvwrapper を完全に書き直すことなく修正できるなら、
bitbucket のプロジェクトページを通じて pull リクエストを
送ってください。あなたが非互換なシェル上で動作させるクローンを
作成するなら、このページでリンクを張るので私に連絡してください。
Python バージョン
=================
virtualenvwrapper は Python 2.4 - 2.7 でテストされています。
1.x からのアップグレード
========================
ラッパー関数を含むシェルスクリプトは 2.x バージョンで bash
以外のシェルをサポートするためにその名前が変更されました。
あなたの起動ファイルの ``source /usr/local/bin/virtualenvwrapper_bashrc`` を
``source /usr/local/bin/virtualenvwrapper.sh`` へ変更してください。
====
貢献
====
virtualenvwrapper のコアへ新しい機能を追加する前に、
その代わりに機能拡張として実装すべきかどうかをよく考えてください。
パッチを提供するための tips は
`開発者ドキュメント <http://www.doughellmann.com/docs/virtualenvwrapper/developers.html>`__
を参照してください。
========
サポート
========
問題や機能を議論するには
`virtualenvwrapper Google Group <http://groups.google.com/group/virtualenvwrapper/>`__
に参加してください。
`BitBucket のバグトラッカー <http://bitbucket.org/dhellmann/virtualenvwrapper/>`__
でバグを報告してください。
シェルエイリアス
================
virtualenvwrapper は大きなシェルスクリプトなので、
多くのアクションはシェルコマンドを使用します。
あなたの環境が多くのシェルエイリアスやその他の
カスタマイズを行っているなら、何かしら問題に
遭遇する可能性があります。バグトラッカーにバグを
報告する前に、そういったエイリアスを無効な *状態* で
テストしてください。あなたがその問題を引き起こす
エイリアスを判別できるなら virtualenvwrapper を
もっと堅牢なものにすることに役立つでしょう。
==========
ライセンス
==========
Copyright Doug Hellmann, All Rights Reserved
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.
......@@ -11,6 +11,13 @@ managing your development workflow, making it easier to work on more
than one project at a time without introducing conflicts in their
dependencies.
**Warning:** The 4.x release includes some potentially incompatible
changes for extensions from 3.x. The python modules for extensions are
now *always* run with ``PWD=$WORKON_HOME`` (previously the value of
PWD varied depending on the hook). The *shell* portion of any hook
(anything sourced by the user's shell when the hook is run) is still
run in the same place as before.
========
Features
========
......@@ -30,7 +37,7 @@ Features
6. Plugin system for more creating sharable extensions.
Rich Leland has created a short `screencast
<http://mathematism.com/2009/jul/30/presentation-pip-and-virtualenv/>`__
<http://mathematism.com/2009/07/30/presentation-pip-and-virtualenv/>`__
showing off the features of virtualenvwrapper.
============
......@@ -45,7 +52,7 @@ Supported Shells
================
virtualenvwrapper is a set of shell *functions* defined in Bourne
shell compatible syntax. It is tested under `bash`, `ksh`, and `zsh`.
shell compatible syntax. It is tested under ``bash``, ``ksh``, and ``zsh``.
It may work with other shells, so if you find that it does work with a
shell not listed here please let me know. If you can modify it to
work with another shell, without completely rewriting it, send a pull
......@@ -56,34 +63,7 @@ from this page.
Python Versions
===============
virtualenvwrapper is tested under Python 2.4 - 2.7.
Upgrading to 2.9
================
Version 2.9 includes the features previously delivered separately by
``virtualenvwrapper.project``. If you have an older verison of the
project extensions installed, remove them before upgrading.
Upgrading from 1.x
==================
The shell script containing the wrapper functions has been renamed in
the 2.x series to reflect the fact that shells other than bash are
supported. In your startup file, change ``source
/usr/local/bin/virtualenvwrapper_bashrc`` to ``source
/usr/local/bin/virtualenvwrapper.sh``.
============
Contributing
============
Before contributing new features to virtualenvwrapper core, consider
whether they should be implemented as an extension instead.
Refer to the `developers docs
<http://www.doughellmann.com/docs/virtualenvwrapper/developers.html>`__
for tips on contributing patches.
virtualenvwrapper is tested under Python 2.6 - 3.3.
=======
Support
......
=======================
virtualenvwrapper 4.1
=======================
.. tags:: virtualenvwrapper release python
What is virtualenvwrapper?
==========================
virtualenvwrapper_ is a set of extensions to virtualenv_. The
extensions include wrappers for creating and deleting virtual
environments and otherwise managing your development workflow, making
it easier to work on more than one project at a time without
introducing conflicts in their dependencies.
What's New?
===========
- Ensure that all ``$()`` style commands that produce paths are
quoted; addresses issue 164.
- Add ``wipeenv`` command for removing all packages installed in the
virtualenv.
- Allow users of ``virtualenvwrapper_lazy.sh`` to extend the list of
API commands that trigger the lazy-loader by extending
``_VIRTUALENVWRAPPER_API``. Patch contributed by John Purnell, see
issue 188.
- Fix detection of ``--python`` option to ``mkvirtualenv``. Resolves
issue 190.
- Add ``allvirtualenv`` command to run a command across all
virtualenvs. Suggested by Dave Coutts in issue 186.
- Fix ``lsvirtualenv`` when there are spaces in
``WORKON_HOME``. Resolves issue 194.
- Switch to `pbr`_ for packaging.
.. _pbr: https://github.com/openstack-dev/pbr
Installing
==========
Visit the virtualenvwrapper_ project page for download links and
installation instructions.
.. _virtualenv: http://pypi.python.org/pypi/virtualenv
.. _virtualenvwrapper: http://virtualenvwrapper.readthedocs.org/en/latest/
This diff is collapsed.
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/virtualenvwrapper.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/virtualenvwrapper.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/virtualenvwrapper"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/virtualenvwrapper"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf: