| OLD | NEW |
| (Empty) |
| 1 Development | |
| 2 =========== | |
| 3 | |
| 4 Contributing | |
| 5 ------------ | |
| 6 | |
| 7 Refer to the `pip development`_ documentation - it applies equally to | |
| 8 virtualenv, except that virtualenv issues should filed on the `virtualenv | |
| 9 repo`_ at GitHub. | |
| 10 | |
| 11 Virtualenv's release schedule is tied to pip's -- each time there's a new pip | |
| 12 release, there will be a new virtualenv release that bundles the new version of | |
| 13 pip. | |
| 14 | |
| 15 Files in the `virtualenv_embedded/` subdirectory are embedded into | |
| 16 `virtualenv.py` itself as base64-encoded strings (in order to support | |
| 17 single-file use of `virtualenv.py` without installing it). If your patch | |
| 18 changes any file in `virtualenv_embedded/`, run `bin/rebuild-script.py` to | |
| 19 update the embedded version of that file in `virtualenv.py`; commit that and | |
| 20 submit it as part of your patch / pull request. | |
| 21 | |
| 22 .. _pip development: http://www.pip-installer.org/en/latest/development.html | |
| 23 .. _virtualenv repo: https://github.com/pypa/virtualenv/ | |
| 24 | |
| 25 Running the tests | |
| 26 ----------------- | |
| 27 | |
| 28 Virtualenv's test suite is small and not yet at all comprehensive, but we aim | |
| 29 to grow it. | |
| 30 | |
| 31 The easy way to run tests (handles test dependencies automatically):: | |
| 32 | |
| 33 $ python setup.py test | |
| 34 | |
| 35 If you want to run only a selection of the tests, you'll need to run them | |
| 36 directly with pytest instead. Create a virtualenv, and install required | |
| 37 packages:: | |
| 38 | |
| 39 $ pip install pytest mock | |
| 40 | |
| 41 Run pytest:: | |
| 42 | |
| 43 $ pytest | |
| 44 | |
| 45 Or select just a single test file to run:: | |
| 46 | |
| 47 $ pytest tests/test_virtualenv | |
| 48 | |
| 49 Status and License | |
| 50 ------------------ | |
| 51 | |
| 52 ``virtualenv`` is a successor to `workingenv | |
| 53 <http://cheeseshop.python.org/pypi/workingenv.py>`_, and an extension | |
| 54 of `virtual-python | |
| 55 <http://peak.telecommunity.com/DevCenter/EasyInstall#creating-a-virtual-python>`
_. | |
| 56 | |
| 57 It was written by Ian Bicking, sponsored by the `Open Planning | |
| 58 Project <http://openplans.org>`_ and is now maintained by a | |
| 59 `group of developers <https://github.com/pypa/virtualenv/raw/master/AUTHORS.txt>
`_. | |
| 60 It is licensed under an | |
| 61 `MIT-style permissive license <https://github.com/pypa/virtualenv/raw/master/LIC
ENSE.txt>`_. | |
| OLD | NEW |