Skip to content
Permalink
Browse files

Update base docs.

  • Loading branch information
keith.dart
keith.dart committed Jun 15, 2012
1 parent c234268 commit b37091a71afe3ddc6f9ff3e6851ee8dd72307bd7
Showing with 46 additions and 90 deletions.
  1. +45 −0 INSTALL
  2. +1 −90 README
45 INSTALL
@@ -0,0 +1,45 @@
.. Copyright 2012-, Keith Dart
..
.. vim:ts=4:sw=4:softtabstop=4:smarttab:expandtab
..
.. This document is in RST format <http://docutils.sourceforge.net/rst.html>.


INSTALL
=======

NOTE: The install operation requires that the sudo command be configured for you.

There are many dependencies. You should see the primary installation
documentation under doc/source/install.


Install script
--------------

The top-level setup script helps with dealing with all sub-packages at
once. It also provides an installer for a developer mode.

Invoke it like a standard setup.py script. However, Any names after the
operation name are taken as sub-package names that are operated on. If no
names are given then all packages are operated on.

Commands:
list -- List available subpackages. These are the names you may optionally supply.
publish -- Put source distribution on pypi.
build -- Run setuptools build phase on named sub-packages (or all of them).
install -- Run setuptools install phase.
eggs -- Build distributable egg package.
rpms -- Build RPMs on platforms that support building RPMs.
msis -- Build Microsoft .msi on Windows.
wininst -- Build .exe installer on Windows.
develop -- Developer mode, as defined by setuptools.
develophome -- Developer mode, installing .pth and script files in user directory.
clean -- Run setuptools clean phase.
squash -- Squash (flatten) all named sub-packages into single tree
in $PYCOPIA_SQUASH, or user site-directory if no $PYCOPIA_SQUASH defined.
This also removes the setuptools runtime dependency.

Most regular setuptools commands also work. They are passed through by
default.

91 README
@@ -47,94 +47,5 @@ license. Parts here may be Other Peoples Code under the BSD or MIT license.
INSTALL
=======

The top-level setup script helps with dealing with all sub-packages at
once. It also provides an installer for a nicer developer mode.

Invoke it like a standard setup.py script. However, Any names after the
operation name are taken as sub-package names that are operated on. If no
names are given then all packages are operated on.

Commands:
list -- List available subpackages. These are the names you may optionally supply.
publish -- Put source distribution on pypi.
build -- Run setuptools build phase on named sub-packages (or all of them).
install -- Run setuptools install phase.
eggs -- Build distributable egg package.
rpms -- Build RPMs on platforms that support building RPMs.
msis -- Build Microsoft .msi on Windows.
wininst -- Build .exe installer on Windows.
develop -- Developer mode, as defined by setuptools.
develophome -- Developer mode, installing .pth and script files in user directory.
clean -- Run setuptools clean phase.
squash -- Squash (flatten) all named sub-packages into single tree
in $PYCOPIA_SQUASH, or user site-directory if no $PYCOPIA_SQUASH defined.
This also removes the setuptools runtime dependency.

Most regular setuptools commands also work. They are passed through by
default.

NOTE: The install operation requires that the sudo command be configured for you.


Prerequisites
-------------

Installation requires haveing some additional build-time dependencies installed
first.

Many of these are

Required for building
+++++++++++++++++++++

python-dev -- Of course, Python and any development packages.
setuptools -- For its namespace package support and general building.
pyrex -- Some extension modules need to to generate C files.
libsmi -- For SMI parsing.

Optional
++++++++

Packages required at run time. Many of these are automatically installed
from pypi at installation time.

====================================== ================================
Package Name Version (minimum)
====================================== ================================
docutils 0.5
simplejson 2.1
python-xml 0.8.4
pyro 3.9
sqlalchemy 0.6.5
postgresql 8.4
====================================== ================================

Ubuntu Package Names (use apt-get)
++++++++++++++++++++++++++++++++++

- python-dev
- python-pyrex
- python-setuptools
- python-sqlalchemy
- python-4suite-xml
- python-simplejson
- python-psycopg2
- libsmi2
- libsmi2-dev
- postgresql


Gentoo Package Names (use emerge)
+++++++++++++++++++++++++++++++++

- dev-lang/python
- dev-python/setuptools
- dev-python/pyrex
- dev-python/simplejson
- dev-python/pyxml
- dev-python/psycopg
- net-libs/libsmi
- dev-python/sqlalchemy
- dev-db/postgresql-server

See the INSTALL file.

0 comments on commit b37091a

Please sign in to comment.
You can’t perform that action at this time.