summaryrefslogtreecommitdiff
path: root/docs/source/download.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/download.rst')
-rw-r--r--docs/source/download.rst74
1 files changed, 74 insertions, 0 deletions
diff --git a/docs/source/download.rst b/docs/source/download.rst
new file mode 100644
index 0000000..44dd72a
--- /dev/null
+++ b/docs/source/download.rst
@@ -0,0 +1,74 @@
+Download PySNMP
+===============
+
+.. toctree::
+ :maxdepth: 2
+
+The PySNMP software is provided under terms and conditions of BSD-style
+license, and can be freely downloaded from Source Forge
+`download servers <http://sourceforge.net/projects/pysnmp/files/>`_ or
+`PyPI <http://pypi.python.org/pypi/pysnmp/>`_.
+
+Please, note that there are frequently release candidate versions (marked rc)
+also available for download. These are potentially less stable in terms of
+implementation and public interfaces. However they are first to contain
+fixes to the issues, discovered in latest stable branch.
+
+But the simplest way to obtain PySNMP is to run:
+
+.. code-block:: bash
+
+ $ easy_install pysnmp
+
+or
+
+.. code-block:: bash
+
+ $ pip install pysnmp
+
+Those Python package managers will download PySNMP along with all its
+dependencies and install them all on your system.
+
+In case you do not have the easy_install command on your system but still
+would like to use the on-line package installation method, please install
+`setuptools <http://pypi.python.org/pypi/setuptools>`_ package by
+downloading and running `ez_setup.pz <https://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py>`_ bootstrap:
+
+.. code-block:: bash
+
+ # wget https://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py
+ # python ez_setup.py
+
+In case you are installing PySNMP on an off-line system, the following
+packages need to be downloaded and installed for PySNMP to become
+operational:
+
+* `PyASN1 <http://pypi.python.org/packages/source/p/pyasn1/>`_,
+ used for handling ASN.1 objects
+* `PySNMP <http://pypi.python.org/packages/source/p/pysnmp/>`_,
+ SNMP engine implementation
+
+Optional, but recommended:
+
+* `PyCrypto <http://pypi.python.org/packages/source/p/pycrypto/>`_,
+ used by SNMPv3 crypto features (Windows users need
+ `precompiled version <http://www.voidspace.org.uk/python/modules.shtml>`_)
+* `PySMI <http://pypi.python.org/packages/source/p/pysmi/>`_ for automatic
+ MIB download and compilation. That helps visualizing more SNMP objects
+* `Ply <http://pypi.python.org/packages/source/p/ply/>`_, parser generator
+ required by PySMI
+
+The installation procedure for all the above packages is as follows
+(on UNIX-based systems):
+
+.. code-block:: bash
+
+ $ tar zxf package-X.X.X.tar.gz
+ $ cd package-X.X.X
+ # python setup.py install
+ # cd ..
+ # rm -rf package-X.X.X
+
+In case of any issues, please `let us know <http://pysnmp.sourceforge.net/contact.html>`_ so we could try to help out.
+
+