Commit 65c13cb2 authored by tarek's avatar tarek

reorganized texts

--HG--
branch : distribute
extra : rebase_source : 82617065dd28e25a4f293e83d9c81a6cb1b56720
parent 5c6e640a
============
Contributors
============
* Alex Grönholm
* Hanno Schlichting
* Lennart Regebro
* Martin von Loewis
* Philip Envey
* Tarek Ziadé
If you think you name is missing, please add it (alpha order by first name)
......@@ -11,10 +11,24 @@ Disclaimers
About the fork
==============
`Distribute` is a friendly fork of the `Setuptools` project. The `Setuptools`
maintainer, Phillip J. Eby is not responsible of any aspect of this fork.
`Distribute` is a fork of the `Setuptools` project.
If you install `Distribute` and want to switch back for any reason to
Distribute is intended to replace Setuptools as the standard method
for working with Python module distributions.
The fork has two goals:
- Provides a backward compatible version to replace Setuptools
and make all distributions that depend on Setuptools work as
before, but with less bugs and behavior issues.
This version is also compatible with Python 3.
This work is done in the 0.6.x series
- Refactor the code, and release it in several distributions.
This work is done in the 0.7.x series but not yet released.
If you install `Distribute` and want to switch back for any reason to
`Setuptools`, get to the `Uninstallation instructions`_ section.
About the installation process
......@@ -37,8 +51,9 @@ Installation Instructions
Distribute is only released as a source distribution.
It can be installed using easy_install or pip, with the source tarball, with the
eggs distribution, or using the ``distribute_setup.py`` script provided online.
It can be installed using easy_install or pip, and can be done so with the source
tarball, the eggs distribution, or by using the ``distribute_setup.py`` script
provided online.
``distribute_setup.py`` is the simplest and preferred way on all systems.
......@@ -48,7 +63,7 @@ distribute_setup.py
Download ``distribute_setup.py`` and execute it, using the Python interpreter of
your choice.
If your shell has the `wget` program you can do::
If your shell has the ``wget`` program you can do::
$ wget http://nightly.ziade.org/distribute_setup.py
$ python distribute_setup.py
......@@ -64,11 +79,11 @@ Run easy_install or pip::
Source installation
===================
Download the source tarball, and uncompress it, then run the install command::
Download the source tarball, uncompress it, then run the install command::
$ wget http://pypi.python.org/packages/source/d/distribute/distribute-0.6.2.tar.gz
$ tar -xzvf distribute-0.6.2.tar.gz
$ cd distribute-0.6.2
$ wget http://pypi.python.org/packages/source/d/distribute/distribute-0.6.1.tar.gz
$ tar -xzvf distribute-0.6.1.tar.gz
$ cd distribute-0.6
$ python setup.py install
---------------------------
......@@ -76,29 +91,29 @@ Uninstallation Instructions
---------------------------
Like other distutils-based distributions, Distribute doesn't provide an
uninstaller yet. It's all manual !
uninstaller yet. It's all done manually!
Distribute is installed in three steps:
1- it gets out of the way an existing installation of Setuptools
2- it installs a `fake` setuptools installation
3- it installs distribute
1. it gets out of the way an existing installation of Setuptools
2. it installs a `fake` setuptools installation
3. it installs distribute
Distribute can be removed like this:
- run `easy_install -m Distribute`. This will remove the Distribute reference
from `easy-install.pth` *or* edit the file and remove it yourself.
- remove the distribute*.egg file located in your site-packages directory
- remove the setuptools.pth file located in you site-packages directory
- remove the easy_install script located in you sys.prefix/bin directory
- remove the setuptools*.egg directory located in your site-packages directory
- run ``easy_install -m Distribute``. This will remove the Distribute reference
from ``easy-install.pth``. Otherwise, edit the file and remove it yourself.
- remove the ``distribute*.egg`` file located in your site-packages directory
- remove the ``setuptools.pth`` file located in you site-packages directory
- remove the easy_install script located in you ``sys.prefix/bin`` directory
- remove the ``setuptools*.egg`` directory located in your site-packages directory,
if any.
If you want to get back to setuptools:
- reinstall setuptools using its instruction.
Last:
Lastly:
- remove the *.OLD.* directory located in your site-packages directory if any,
**once you have checked everything was working correctly again**.
......@@ -107,7 +122,7 @@ Last:
Install FAQ
-----------
- **Why Distribute turn my Setuptools installation into an fake one ?**
- **Why Distribute turn my Setuptools installation into an fake one?**
Since Distribute is a fork, and since it provides the same package and modules,
it fakes that the Setuptools installation is still present, so all the programs
......@@ -116,7 +131,7 @@ Install FAQ
If it wasn't doing it, a program that would try to install Setuptools
would overwrite in turn Distribute.
- **How does Distribute interacts with virtualenv ?**
- **How does Distribute interacts with virtualenv?**
Everytime you create a virtualenv it will install setuptools, so you need to
re-install Distribute in it right after. The Distribute project will not
......@@ -131,25 +146,24 @@ Install FAQ
You need in this case to build a virtualenv with the --no-site-packages option
or to install `Distribute` globally.
- **How does Distribute interacts with zc.buildout ?**
- **How does Distribute interact with zc.buildout?**
Some work is being done on zc.buildout side to make its bootstrap
work with Distribute. Until then, using Distribute in zc.buildout is a bit
tricky.
Like virtualenv, Distribute has to be installed after setuptools. The simplest
way is to add it in a `zc.recipe.egg` section so the job is done when you
way is to add it in a ``zc.recipe.egg`` section so the job is done when you
build your buildout.
If you are combining zc.buildout and virtualenv, you might fail in the
problem described in the previous FAQ entry.
Last, you will need to use the provided special `bootstrap.py` file,
located in the buildout directory.
-------
Credits
-------
-----------------------------
Feedback and getting involved
-----------------------------
* Tarek Ziadé
* Hanno Schlichting
* Many other people that helped on Distutils-SIG (please add your name here)
* Phillip Eby for the Setuptools project.
- Mailing list: http://mail.python.org/mailman/listinfo/distutils-sig
- Issue tracker: http://bitbucket.org/tarek/distribute/issues/
- Code Repository: http://bitbucket.org/tarek/distribute
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment