File: command_ref.rst

package info (click to toggle)
virtualenvwrapper 3.4-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 4,140 kB
  • sloc: sh: 3,801; python: 991; makefile: 27
file content (327 lines) | stat: -rw-r--r-- 9,796 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
.. Quick reference documentation for virtualenvwrapper command line functions
    Originally contributed Thursday, May 28, 2009 by Steve Steiner (ssteinerX@gmail.com)

.. _command:

######################
Referencia de comandos
######################

Todos los comandos, mostrados a continuación, son para ser utilizados 
en una Terminal de línea de comandos.

====================
Administrar entornos
====================

.. _command-mkvirtualenv:

mkvirtualenv
------------

Crea un nuevo entorno, dentro de WORKON_HOME.

Sintaxis::

    mkvirtualenv [options] ENVNAME

Todas las opciones de línea de comandos son pasados directamente a
``virtualenv``. El nuevo entorno es automáticamente activado luego de su
inicialización.

::

    $ workon
    $ mkvirtualenv mynewenv
    New python executable in mynewenv/bin/python
    Installing distribute.............................................
    ..................................................................
    ..................................................................
    done.
    (mynewenv)$ workon
    mynewenv
    (mynewenv)$ 

.. seealso::

   * :ref:`scripts-premkvirtualenv`
   * :ref:`scripts-postmkvirtualenv`

rmvirtualenv
------------

Elimina un entorno, dentro de WORKON_HOME.

Sintaxis::

    rmvirtualenv ENVNAME

Debes usar :ref:`command-deactivate` antes de eliminar el entorno actual.

::

    (mynewenv)$ deactivate
    $ rmvirtualenv mynewenv
    $ workon
    $

.. seealso::

   * :ref:`scripts-prermvirtualenv`
   * :ref:`scripts-postrmvirtualenv`

.. _command-cpvirtualenv:

cpvirtualenv
------------

Duplica un entorno, dentro de WORKON_HOME.

Sintaxis::

    cpvirtualenv ENVNAME TARGETENVNAME

.. note::

   El entorno creado por la operación de copia es hecho `reubicable
   <http://virtualenv.openplans.org/#making-environments-relocatable>`__.

::

    $ workon 
    $ mkvirtualenv source
    New python executable in source/bin/python
    Installing distribute.............................................
    ..................................................................
    ..................................................................
    done.
    (source)$ cpvirtualenv source dest
    Making script /Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/easy_install relative
    Making script /Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/easy_install-2.6 relative
    Making script /Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/pip relative
    Script /Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/postactivate cannot be made relative (it's not a normal script that starts with #!/Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/python)
    Script /Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/postdeactivate cannot be made relative (it's not a normal script that starts with #!/Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/python)
    Script /Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/preactivate cannot be made relative (it's not a normal script that starts with #!/Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/python)
    Script /Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/predeactivate cannot be made relative (it's not a normal script that starts with #!/Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/python)
    (dest)$ workon 
    dest
    source
    (dest)$ 

.. seealso::

   * :ref:`scripts-precpvirtualenv`
   * :ref:`scripts-postcpvirtualenv`
   * :ref:`scripts-premkvirtualenv`
   * :ref:`scripts-postmkvirtualenv`

==============================
Controlar los entornos activos
==============================

workon
------

Lista o cambia el entorno de trabajo actual

Sintaxis::

    workon [environment_name]

Si no se especifica el ``environment_name``, la lista de entornos disponibles es
impresa en la salida estándar.

::

    $ workon 
    $ mkvirtualenv env1
      New python executable in env1/bin/python
    Installing distribute.............................................
    ..................................................................
    ..................................................................
    done.
    (env1)$ mkvirtualenv env2
    New python executable in env2/bin/python
    Installing distribute.............................................
    ..................................................................
    ..................................................................
    done.
    (env2)$ workon 
    env1
    env2
    (env2)$ workon env1
    (env1)$ echo $VIRTUAL_ENV
    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env1
    (env1)$ workon env2
    (env2)$ echo $VIRTUAL_ENV
    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env2
    (env2)$ 


.. seealso::

   * :ref:`scripts-predeactivate`
   * :ref:`scripts-postdeactivate`
   * :ref:`scripts-preactivate`
   * :ref:`scripts-postactivate`

.. _command-deactivate:

deactivate
----------

Cambia de un entorno virtual a la versión instalada de Python en el sistema.

Sintaxis::

    deactivate

.. note::

    Este comando es actualmente parte de virtualenv, pero es encapsulado para
    proveer ganchos antes y después, al igual que workon hace para *activate*.

::

    $ workon 
    $ echo $VIRTUAL_ENV

    $ mkvirtualenv env1
    New python executable in env1/bin/python
    Installing distribute.............................................
    ..................................................................
    ..................................................................
    done.
    (env1)$ echo $VIRTUAL_ENV
    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env1
    (env1)$ deactivate
    $ echo $VIRTUAL_ENV

    $ 

.. seealso::

   * :ref:`scripts-predeactivate`
   * :ref:`scripts-postdeactivate`

======================================
Rápida navegación dentro de virtualenv
======================================

Existen dos funciones que proveen atajos para navegar dentro del virtualenv
actualmente activado.

cdvirtualenv
------------

Cambia el directorio de trabajo actual hacia ``$VIRTUAL_ENV``.

Sintaxis::

    cdvirtualenv [subdir]

Al llamar ``cdvirtualenv`` se cambia el directorio de trabajo actual hacia la
sima de virtualenv (``$VIRTUAL_ENV``). Un argumento adicional es agregado a la
ruta, permitiendo navegar directamente dentro de un subdirectorio.

::

    $ mkvirtualenv env1
    New python executable in env1/bin/python
    Installing distribute.............................................
    ..................................................................
    ..................................................................
    done.
    (env1)$ echo $VIRTUAL_ENV
    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env1
    (env1)$ cdvirtualenv
    (env1)$ pwd
    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env1
    (env1)$ cdvirtualenv bin
    (env1)$ pwd
    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env1/bin

cdsitepackages
--------------

Cambia el directorio de trabajo actual al ``site-packages`` del 
``$VIRTUAL_ENV``.

Sintaxis::

    cdsitepackages [subdir]

Debido a que la ruta exacta hacia el directorio site-packages dentro del
virtualenv depende de la versión de Python, ``cdsitepackages`` es provisto como
un atajo para ``cdvirtualenv lib/python${pyvers}/site-packages``. Un argumento
opcional también está permitido, para especificar un directorio heredado dentro
del directorio ``site-packages`` y así ingresar a este.

::

    $ mkvirtualenv env1
    New python executable in env1/bin/python
    Installing distribute.............................................
    ..................................................................
    ..................................................................
    done.
    (env1)$ echo $VIRTUAL_ENV
    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env1
    (env1)$ cdsitepackages PyMOTW/bisect/
    (env1)$ pwd
    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env1/lib/python2.6/site-packages/PyMOTW/bisect

lssitepackages
--------------

``lssitepackages`` muestra el contenido del directorio ``site-packages``
del entorno actualmente activado.

Sintaxis::

    lssitepackages

::

    $ mkvirtualenv env1
    New python executable in env1/bin/python
    Installing distribute.............................................
    ..................................................................
    ..................................................................
    done.
    (env1)$ $ workon env1
    (env1)$ lssitepackages 
    distribute-0.6.10-py2.6.egg     pip-0.6.3-py2.6.egg
    easy-install.pth                setuptools.pth

=======================
Administración de rutas
=======================

add2virtualenv
--------------

Agrega los directorios especificados al path de Python para el entorno virtual
actualmente activo.

Sintaxis::

    add2virtualenv directory1 directory2 ...

A veces esto es útli para compartir paquetes instalados que no están en el
directorio ``site-pacakges`` del sistema y no deben ser instalados en cada
entorno virtual. Una posible solución es crear enlaces simbólicos (*symlinks*)
hacia el código dentro del directorio ``site-packages`` del entorno, pero
también es fácil agregar a la variable PYTHONPATH directorios extras que están
incluidos en los archivos ``.pth`` dentro de ``site-packages`` usando ``add2virtualenv``.

1. Descarga (*check out*) el código de un proyecto grande, como Django.
2. Ejecuta: ``add2virtualenv path_to_source``.
3. Ejecuta: ``add2virtualenv``.
4. Un mensaje de uso y una lista de las rutas "extras" actuales es impreso.

Los nombres de los directorios son agregados a un archivo llamado
``virtualenv_path_extensions.pth`` dentro del directorio site-packages de este
entorno.

*Basado en una contribución de James Bennett y Jannis Leidel.*