Metadata-Version: 1.1
Name: gen-cisco
Version: 1.2.9
Summary: Generates Cisco scripts based on YAML files
Home-page: https://github.com/rememberYou/gen-cisco
Author: Terencio Agozzino
Author-email: terencio.agozzino@gmail.com
License: MIT
Project-URL: Source, https://github.com/rememberYou/gen-cisco
Project-URL: Tracker, https://github.com/rememberYou/gen-cisco/issues
Description: |Cisco Logo| gen-cisco
        ======================
        
        |License| |Version|
        
        ``gen-cisco`` is an API and CLI to facilitate the creation of your Cisco
        scripts using a YAML file. This file groups a section for each protocol
        including the values to be replaced in the appropriate Cisco template.
        
        The creation of these templates has been done during the various *CCNA*
        training courses offered by Cisco, using `Packet
        Tracer <https://www.netacad.com/courses/packet-tracer-download/>`__, a
        network simulation and visualization tool. Therefore, some commands may
        need to be modified on real hardware.
        
        --------------
        
        Installation
        ~~~~~~~~~~~~
        
        It’s as simple as that:
        
        ::
        
           pip install gen-cisco
        
        --------------
        
        Usage
        ~~~~~
        
        ::
        
           Usage: gen-cisco.py [OPTIONS]
        
             Generates Cisco scripts based on YAML files
        
             Examples:
               python gen-cisco.py -i examples/router.yml
               python gen-cisco.py -i examples/router.yml -o r1.txt
               python gen-cisco.py -i examples/router.yml -o r1.txt -v
               python gen-cisco.py -i examples/router.yml -o r1.txt --no-comments -v
               python gen-cisco.py -i examples/router.yml -o r1.txt --no-comments --no-headers -v
               python gen-cisco.py -i examples/router.yml -o r1.txt --no-override
        
           Options:
             -i, --src FILENAME          The YAML file.
             -o, --dest TEXT             The name of the generated script file.
             --override / --no-override  Deletes the old file if it is overwritten.
             --comments / --no-comments  Deletes comments in the generated script.
             --headers / --no-headers    Deletes headers in the generated script.
             -v, --verbose               Outputs the final script to the console.
             --version                   Show the version and exit.
             --help                      Show this message and exit.
        
        Alternatively you can run this tool using Docker:
        
        .. code:: bash
        
           # Build the image
           docker build -t gen-cisco .
        
           # Run the image
           docker run -v $(pwd):/app gen-cisco python gen-cisco.py [OPTIONS]
        
        --------------
        
        Supported Features
        ~~~~~~~~~~~~~~~~~~
        
        Here is a list of features configurable by the scripts:
        
        ::
        
            basic               ➔ basic configuration for routers and switches
            eigrp               ➔ advanced distance-vector routing protocol
            etherchannel        ➔ port link aggregation technology or port-channel architecture used primarily on Cisco switches
            hsrp                ➔ Cisco redundancy protocol for establishing a fault-tolerant default gateway
            nat                 ➔ method of remapping one IP address space into another
            ospf                ➔ routing protocol for Internet Protocol networks
            rip                 ➔ one of the oldest distance-vector routing protocols
            stp                 ➔ network protocol that builds a loop-free logical topology for Ethernet networks
            ssh                 ➔ cryptographic network protocol for operating network services securely over an unsecured network
        
        For a complete list sorted by device, please visit the
        `wiki <https://github.com/rememberYou/gen-cisco/wiki/Supported-Features>`__.
        
        --------------
        
        Contributions
        ~~~~~~~~~~~~~
        
        Adding a new protocol to script as well as supporting a new device is
        easy. To do that, first take a look at the
        `CONTRIBUTING <https://github.com/rememberYou/gen-cisco/blob/master/CONTRIBUTING.md>`__
        file. Also, feel free to submit your bugs and suggestions by opening an
        issue in the issue tracker, it would help us a lot.
        
        --------------
        
        License
        ~~~~~~~
        
        Code is under the `MIT
        License <https://github.com/rememberYou/gen-cisco/blob/master/LICENSE>`__.
        
        .. |Cisco Logo| image:: assets/cisco.png
        .. |License| image:: https://img.shields.io/badge/License-MIT-green.svg
        .. |Version| image:: https://img.shields.io/badge/version-1.2.9-blue.svg
        
        
Keywords: cisco ccna generate generator jinja netacad packettracer     pythonscript scripts yaml
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Utilities
