Metadata-Version: 1.1
Name: ciscoconfparse
Version: 1.1.21
Summary: Parse, Audit, Query, Build, and Modify Cisco IOS-style configurations
Home-page: http://www.pennington.net/py/ciscoconfparse/
Author: David Michael Pennington
Author-email: mike /|at|\ pennington.net
License: GPL
Description: ==============
        ciscoconfparse
        ==============
        
        .. image:: https://travis-ci.org/mpenning/ciscoconfparse.png?branch=master
           :target: https://travis-ci.org/mpenning/ciscoconfparse
           :alt: Travis CI Status
        
        .. image:: https://badge.fury.io/py/ciscoconfparse.png
           :target: https://pypi.python.org/pypi/ciscoconfparse/
           :alt: Version
        
        .. image:: https://pypip.in/license/ciscoconfparse/badge.png
           :target: https://pypi.python.org/pypi/ciscoconfparse/
           :alt: License
        
        .. image:: https://pypip.in/d/ciscoconfparse/badge.png
           :target: https://pypi.python.org/pypi/ciscoconfparse
           :alt: Downloads
        
        .. contents::
        
        .. _introduction:
        
        Introduction: What is ciscoconfparse?
        =====================================
        
        ciscoconfparse_ parses, audits, queries, builds, and modifies Cisco IOS 
        configurations.
        
        Docs
        ====
        
        The latest copy of the docs are `archived on the web <http://www.pennington.net/py/ciscoconfparse/>`_
        
        .. _Pre-Requisites:
        
        Pre-requisites
        ==============
        
        ciscoconfparse_ needs  Python versions 2.6, 2.7 or 3.2+; the OS should not
        matter. If you want to run it under a Python virtualenv_, it's been heavily 
        tested in that environment as well.
        
        .. _Installation:
        
        Installation and Downloads
        ==========================
        
        The best way to get ciscoconfparse is with setuptools_ or pip_.  If you 
        already have setuptools_, you can install as usual:
        
        ::
        
              # Substitute whatever ciscoconfparse version you like...
              easy_install -U ciscoconfparse==1.1.21
        
        Alternatively you can install into Python2.x with pip_:
        
        ::
        
              pip install --upgrade ciscoconfparse
        
        Use ``pip3`` for Python3.x...
        
        ::
        
              pip3 install --upgrade ciscoconfparse
        
        Otherwise `download it from PyPi <https://pypi.python.org/pypi/ciscoconfparse>`_, extract it and run the ``setup.py`` script:
        
        ::
        
              python setup.py install
        
        If you're interested in the source, you can always pull from the `github repo`_
        or `bitbucket repo`_:
        
        
        - From github_:
          ::
        
              git clone git://github.com//mpenning/ciscoconfparse
        
        
        - From bitbucket_:
          ::
        
              hg init
              hg clone https://bitbucket.org/mpenning/ciscoconfparse
        
        
        .. _`License and Copyright`:
        
        License and Copyright
        =====================
        
        ciscoconfparse_ is licensed GPLv3_; Copyright `David Michael Pennington`_, 
        2007-2014.
        
        The `ipaddr`_ module is distributed with ciscoconfparse_ to facilitate unit
        tests. `ipaddr`_ uses the `ASF License 2.0`_; `ipaddr`_ is part of the Python
        standard library, starting in Python 3.3 (it's called ``ipaddress`` in Python3).
        
        .. _FAQ:
        
        FAQ
        ===
        
        #) *QUESTION*: I want to use ciscoconfparse_ with Python3; is that safe?  *ANSWER*: As long as you're using Python 3.2 or higher, it's safe. I test every release against Python 3.2+.
        
        #) *QUESTION*: Some of the code in the documentation looks different than what I'm used to seeing.  Did you change something?  *ANSWER*: Yes, starting around ciscoconfparse_ v0.9.10 I introducted more methods directly on ``IOSConfigLine()`` objects; going forward, these methods are the preferred way to use ciscoconfparse_.  Please start using the new methods shown in the example, since they're faster, and you type much less code this way.
        
        #) *QUESTION*: ciscoconfparse_ saved me a lot of time, I want to give money.  Do you have a donation link?  *ANSWER*:  I love getting emails like this; helping people get their jobs done is why I wrote the module.  However, I'm not accepting donations.
        
        #) *QUESTION*: Is there a way to use this module with perl?  *ANSWER*: Yes, I do this myself. Install the python package as you normally would and import it into perl with ``Inline.pm`` and ``Inline::Python`` from CPAN.
        
        #) *QUESTION*: When I use ``find_children("interface GigabitEthernet3/2")``, I'm getting all interfaces beginning with 3/2, including 3/21, 3/22, 3/23 and 3/24. How can I limit my results?  *ANSWER*: There are two ways... the simplest is to use the 'exactmatch' option...  ``find_children("interface GigabitEthernet3/2", exactmatch=True)``. Another way is to utilize regex expansion that is native to many methods... ``find_children("interface GigabitEthernet3/2$")``
        
        .. _`Other-Resources`:
        
        Other Resources
        ===============
        
         * `Dive into Python3`_ is a good way to learn Python
         * `Team CYMRU`_ has a `Secure IOS Template`_, which is especially useful for external-facing routers / switches
         * `Cisco's Guide to hardening IOS devices`_
        
        .. _`Bug-Tracker-and-Support`:
        
        Bug Tracker and Support
        =======================
        
        ciscoconfparse Support
        ----------------------
        
        Please report any suggestions, bug reports, or annoyances with 
        ciscoconfparse_ through the `github bug tracker`_.
        
        Python Support
        --------------
        
        If you're having problems with general python issues, consider searching for
        a solution on `Stack Overflow`_.  If you can't find a solution for your problem
        or need more help, you can `ask a question`_.
        
        Cisco Support
        -------------
        
        If you're having problems with your Cisco devices, you can open a case with 
        `Cisco TAC`_; if you prefer crowd-sourcing, you can ask on the Stack Exchange 
        `Network Engineering`_ site.
        
        .. _Contributing:
        
        Contributing
        ============
        
        ciscoconfparse_ is developed with mercurial_, and pushed to bitbucket_.  
        `hg-git`_ keeps `github repo`_ and bitbucket_ in sync, so it shouldn't 
        matter if you just want to fork the `github repo`_.
        
        .. _Unit-Tests:
        
        Unit-Tests
        ==========
        
        I use the `Travis CI project <https://travis-ci.org>`_ to continuously test ciscoconfparse on Python versions 2.6 through 3.4.
        
        Click the image below for details; the current build status is:
        
        .. image:: https://travis-ci.org/mpenning/ciscoconfparse.png?branch=master
           :align: center
           :target: https://travis-ci.org/mpenning/ciscoconfparse
           :alt: Travis CI Status
        
        .. _Author:
        
        Author and Thanks
        =================
        
        ciscoconfparse_ was written by David Michael Pennington (mike [~at~] 
        pennington [/dot\] net).
        
        Special thanks:
        
         * Thanks to David Muir Sharnoff for his suggestion about making a special case for IOS banners.
         * Thanks to Alan Cownie for his API suggestions.
         * Sola Dei Gloria.
        
        
        .. _ciscoconfparse: https://pypi.python.org/pypi/ciscoconfparse
        
        .. _`David Michael Pennington`: http://pennington.net/
        
        .. _setuptools: https://pypi.python.org/pypi/setuptools
        
        .. _pip: https://pypi.python.org/pypi/pip
        
        .. _virtualenv: https://pypi.python.org/pypi/virtualenv
        
        .. _`github repo`: https://github.com/mpenning/ciscoconfparse
        
        .. _`bitbucket repo`: https://bitbucket.org/mpenning/ciscoconfparse
        
        .. _bitbucket: https://bitbucket.org/mpenning/ciscoconfparse
        
        .. _github: https://github.com/mpenning/ciscoconfparse
        
        .. _mercurial: http://mercurial.selenic.com/
        
        .. _`github bug tracker`: https://github.com/mpenning/ciscoconfparse/issues
        
        .. _`hg-git`: http://hg-git.github.io/
        
        .. _`regular expressions`: http://docs.python.org/2/howto/regex.html
        
        .. _`docs`: http://www.pennington.net/py/ciscoconfparse/
        
        .. _`ipaddr`: https://code.google.com/p/ipaddr-py/
        
        .. _`GPLv3`: http://www.gnu.org/licenses/gpl-3.0.html
        
        .. _`ASF License 2.0`: http://www.apache.org/licenses/LICENSE-2.0
        
        .. _`Dive into Python3`: http://www.diveintopython3.net/
        
        .. _`Network Engineering`: http://networkengineering.stackexchange.com/
        
        .. _`Stack Overflow`: http://stackoverflow.com/
        
        .. _`ask a question`: http://stackoverflow.com/questions/ask
        
        .. _`Secure IOS Template`: https://www.cymru.com/Documents/secure-ios-template.html
        
        .. _`Team CYMRU`: http://www.team-cymru.org/
        
        .. _`Cisco TAC`: http://cisco.com/go/support
        
        .. _`Cisco's Guide to hardening IOS devices`: http://www.cisco.com/c/en/us/support/docs/ip/access-lists/13608-21.html
        
Keywords: Parse audit query modify Cisco IOS configuration
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Communications
Classifier: Topic :: Internet
Classifier: Topic :: System :: Networking
Classifier: Topic :: System :: Networking :: Monitoring
Classifier: Topic :: Software Development :: Libraries :: Python Modules
