Changes between Version 16 and Version 17 of setuptools

Timestamp:

Jan 20, 2017, 4:48:19 AM (7 years ago)

Author:

Ryan J Ollos

Comment:

Move some content from 1.3/TracInstall.

setuptools

@@ -1 +1 @@
 = setuptools
+[[PageOutline(2-5, Contents, pullout)]]
 
-[http://peak.telecommunity.com/DevCenter/setuptools setuptools] is a Python module that helps to compile, distribute and install Python packages by wrapping them into "egg"s. Eggs contain additional information to process dependencies, etc.
+[http://peak.telecommunity.com/DevCenter/setuptools setuptools] is a Python module that helps to compile, distribute and install Python packages by packaging them into "egg"s. Eggs contain additional information to process dependencies, etc. The setuptools package is required for installing Trac.
+
+== Check your setuptools version
 
 The version of your setuptools installation can be checked with the following commands (should work for other Python packages too):
@@ -11 +14 @@
 '0.7a1' 
 }}}
+
+== Install setuptools
 
 Setuptools can be installed using the bootstrap script from the [pypi: Python Package Indexer] ([pypi:setuptools#installation-instructions installation instructions]):
@@ -28 +33 @@
  More details can be found in TracInstall#DeployingTrac.
 
-setuptools includes the "easy_install" script for convenient installation of packages found on [pypi:setuptools/ Python Package Index] including Trac with all necessary dependencies.
+== Install Trac using `easy_install`
+
+setuptools includes the `easy_install` script for convenient installation of packages found on [pypi:setuptools/ Python Package Index] including Trac with all necessary dependencies.
 
 {{{#!sh
@@ -34 +41 @@
 }}}
 
+{{{#!div style="border: 1pt dotted; margin: 1em"
+**Note**: `pip` is a modern package installer that was developed as a replacement for `easy_install`, which you should use instead if it's available for your platform. See TracInstall for more information.
+}}}
+
 If you are working behind a proxy, note that easy_install will rely on environment variables, such as http_proxy, https_proxy, ftp_proxy.
+
+== Install Trac from source using `easy_install`
+
+Using the python-typical setup at the top of the source directory also works. You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. `Trac-1.0.tar.gz`) from the [trac:TracDownload] page, or you can get the source directly from the repository. See [trac:TracRepositories#OfficialSubversionrepository TracRepositories] for details.
+
+{{{#!sh
+$ python ./setup.py install
+}}}
+
+''You will need root permissions or equivalent for this step.''
+
+This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
+of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
+
+If you install from source and want to make Trac available in other languages, make sure Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed):
+{{{#!sh
+$ python ./setup.py install
+}}}
+Alternatively, you can run `bdist_egg` and copy the .egg from `dist/` to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
+
+=== Advanced `easy_install` Options
+
+To install Trac to a custom location, or find out about other advanced installation options, run:
+{{{#!sh
+$ easy_install --help
+}}}
+
+Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
+
+Specifically, you might be interested in:
+{{{#!sh
+$ easy_install --prefix=/path/to/installdir
+}}}
+or, if installing Trac on a Mac OS X system:
+{{{#!sh
+$ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages
+}}}
+
+{{{#!div style="border: 1pt dotted; margin: 1em"
+**Mac OS X Note:** On Mac OS X 10.6,  running `easy_install trac` will install into `/usr/local` and `/Library/Python/2.6/site-packages` by default.
+
+The `tracd` and `trac-admin` commands will be placed in `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.6/site-packages`, which is Apple's preferred location for third-party Python application installations.
+}}}
+
 
 == Reference Documentation