Permalink
Browse files

- upgraded project documentation to use Sphinx

  • Loading branch information...
1 parent c33be80 commit 2ca61b1557aa976c6b99e8f71cb6474866e2073f @drkjam committed May 30, 2012
View
Oops, something went wrong.
View
@@ -1,49 +1,52 @@
+Here are the copyright notices applicable to the netaddr library.
+-------
netaddr
-------
- Copyright (c) 2008-2012, David P. D. Moss. All rights reserved.
-
- Released under the BSD license. See the LICENSE file for details.
+Copyright (c) 2008-2012, David P. D. Moss. All rights reserved.
+Released under the BSD license. See the LICENSE file for details.
+---------
intset.py
---------
- Copyright (C) 2006, Heiko Wundram.
-
- Released under the MIT license. See the LICENSE file for details.
+Copyright (C) 2006, Heiko Wundram.
+
+Released under the MIT license. See the LICENSE file for details.
+------------------------------------------
IANA (Internet Assigned Numbers Authority)
------------------------------------------
- netaddr is not sponsored nor endorsed by IANA.
-
- Use of data from IANA (Internet Assigned Numbers Authority) is subject to
- copyright and is provided with prior written permission.
+netaddr is not sponsored nor endorsed by IANA.
- IANA data files included with netaddr are not modified in any way but are
- parsed and made available to end users through an API.
+Use of data from IANA (Internet Assigned Numbers Authority) is subject to
+copyright and is provided with prior written permission.
- See README file and source code for URLs to latest copies of the relevant
- files.
+IANA data files included with netaddr are not modified in any way but are
+parsed and made available to end users through an API.
+See README file and source code for URLs to latest copies of the relevant
+files.
+------------------------------------------
IEEE (Institution of Electrical Engineers)
------------------------------------------
- netaddr is not sponsored nor endorsed by the IEEE.
+netaddr is not sponsored nor endorsed by the IEEE.
- Use of data from the IEEE (Institute of Electrical and Electronics
- Engineers) is subject to copyright. See the following URL for
- details :-
+Use of data from the IEEE (Institute of Electrical and Electronics
+Engineers) is subject to copyright. See the following URL for
+details :-
- http://www.ieee.org/web/publications/rights/legal.html
+http://www.ieee.org/web/publications/rights/legal.html
- IEEE data files included with netaddr are not modified in any way but are
- parsed and made available to end users through an API. There is no
- guarantee that referenced files are not out of date.
+IEEE data files included with netaddr are not modified in any way but are
+parsed and made available to end users through an API. There is no
+guarantee that referenced files are not out of date.
- See README file and source code for URLs to latest copies of the relevant
- files.
+See README file and source code for URLs to latest copies of the relevant
+files.
View
@@ -1,15 +1,11 @@
-
-INSTALLATION
-============
-
-netaddr is available in various packaged and non-packaged forms :-
+netaddr is available in various packaged and non-packaged forms :
- source code repository access
- source release packages (tarball and zip formats)
- Python eggs
- Windows install packages
-Linux distribution specific :-
+Linux distribution specific :
- Ubuntu and Debian (.deb packages)
- Fedora (.rpm packages)
@@ -19,65 +15,64 @@ Please see these Linux projects for availability and installation details.
You can also build your own RPM packages, using bdist_rpm with setup.py
available in the source tarball.
+---------------------
Locating the software
---------------------
netaddr is available directly from the public subversion source code
repository.
-Details on how to check out the source code can be found here :-
+Details on how to check out the source code can be found here :
http://github.com/drkjam/netaddr/
-Official milestone releases can be found here :-
+Official milestone releases can be found here :
http://github.com/drkjam/netaddr/downloads
-
+-----------------------
Source Release Packages
-----------------------
Download the latest release tarball/zip file and extract it to a temporary
location or check out the source from the code hosting site into a local
working copy directory.
-You now have several choices :-
+Run the setup file in the root directory like this::
-- Automated Install
+ python setup.py install
- Run the setup file in the root directory like this :-
+This automatically places the required files in the ``lib/site-packages``
+directory of the Python version you used to run the setup script, may be
+part of a virtualenv or similar.
- python setup.py install
-
- This automatically places the required files in the lib/site-packages
- directory of the Python version you used to run the setup script.
-
-- Manual Install
+-----------
+Python Eggs
+-----------
- Manually copy the netaddr folder and its contents to the lib/site-packages
- directory of your Python interpreter.
+You can build and install eggs with netaddr using the ``setup_egg.py``
+file provided in the source distribution.
-- Soft Linking
+All the usual commands are supported e.g.::
- Add the path of the netaddr folder below the directory where you
- extracted or checked out the source files to your PYTHONPATH environment
- variable. Alternatively, create a netaddr.pth file in your
- lib/site-packages directory containing the path to the netaddr folder
- where the source files are located.
+ python setup_egg.py develop
+ python setup_egg.py bdist_egg
+ ...
+This requires that you install distribute or setuptools which is not part of
+the Python standard library.
-Python Eggs
------------
+See the following URL for details :-
-This requires that you install setuptools which is not distributed as part
-of the Python standard library.
+ - ``distribute`` - http://guide.python-distribute.org/
-See the following URL for details :-
+ - ``setuptools`` (old) - http://peak.telecommunity.com/DevCenter/setuptools
- http://peak.telecommunity.com/DevCenter/setuptools
+.. warning:: ``setuptools`` is now very long in the tooth and full of bugs! \
+ Just use distribute, or pip instead.
Download and install the latest easy_install script and run the following
-command :-
+command ::
easy_install netaddr
@@ -87,11 +82,11 @@ appropriate version of netaddr for your Python setup.
Alternatively, you can use pip instead of easy_install.
Just download the latest version of pip from PyPI found here -
-http://pypi.python.org/pypi/pip and run the following command :-
+http://pypi.python.org/pypi/pip and run the following command ::
pip install netaddr
-
+------------------------
Windows Install Packages
------------------------
@@ -100,19 +95,26 @@ Please note that you may want to download a source zip file as well if you
want local access to the API documentation and unit tests as these are not
distributed along with the code in the Windows install packages.
+^^^^^^^^^^^^
Security Tip
-------------
+^^^^^^^^^^^^
+
+.. warning:: while efforts are made to ensure that the Windows executables \
+ produced are virus free, they cannot be guaranteed to always be 100% free of \
+ possible nasties. Use them solely at your own risk!
+
+If you are either
-Please Note - while efforts are made to ensure that the Windows executables
-produced are virus free, they cannot be guaranteed to always be 100% free of
-possible nasties. Use them solely at your own risk!
+a) paranoid, or
+b) properly and correctly security conscious
-If you are either a) paranoid or b) properly and correctly security conscious
either run your own virus checking software against the setup executable
before installing it or just download the .zip file and install netaddr using
-Python's setup.py script to fully mitigate any potential problems.
+Python's ``setup.py`` script to mitigate any potential problems.
-And finally ...
+-----------
+Final Words
+-----------
Always be sure you verify your downloads against the checksums on the code
hosting site's download page!
View
@@ -1,5 +1,10 @@
-License for netaddr
-===================
+Here are the licenses applicable to the use of the netaddr library.
+
+-------
+netaddr
+-------
+
+COPYRIGHT AND LICENSE
Copyright (c) 2008-2012, David P. D. Moss. All rights reserved.
@@ -30,10 +35,9 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-License(s) for incorporated software
-====================================
-
-intset.py - Immutable integer set type
+---------
+intset.py
+---------
COPYRIGHT AND LICENSE
Oops, something went wrong.

0 comments on commit 2ca61b1

Please sign in to comment.