Metadata-Version: 2.1
Name: mrtopo
Version: 0.1.2
Summary: Mutate Mininet topology files with MrTopo
Home-page: https://github.com/FaizChishtie/mrtopo
Author: faizchishtie
Author-email: faizchishtie@gmail.com
License: MIT
Description: # Mr. Topo
        
        ![Upload Python Package](https://github.com/FaizChishtie/mrtopo/workflows/Upload%20Python%20Package/badge.svg)
        [![PyPI version badge](https://img.shields.io/pypi/v/mrtopo)](https://pypi.org/project/mrtopo/)
        [![PyPI Status Badge](https://img.shields.io/pypi/status/mrtopo)](https://pypi.org/project/mrtopo/)
        [![License](https://img.shields.io/github/license/faizchishtie/mrtopo)](https://github.com/faizchishtie/mrtopo/blob/master/LICENSE)
        [![Downloads per month](https://img.shields.io/pypi/dm/mrtopo)](https://pypi.org/project/mrtopo/)
        
        * Author: Faizaan Chishtie
        
        ## Description
        
        MrTopo is a python application that generates mutant Mininet topology files for network testing purposes.
        
        MrTopo is developed in conjunction with the IoT research being conducted by [Dr. Shiva Nejati](https://engineering.uottawa.ca/people/nejati-shiva) at the University of Ottawa.
        
        ## Basic Usage
        
        ### Option 1: Install the package through `pip`:
        
        ```
        $ pip install mrtopo
        ```
        
        * Run the following:
        
        ```
        $ mrtopo
        Usage: mrtopo [OPTIONS] COMMAND [ARGS]...
        
        Options:
          --help  Show this message and exit.
        
        Commands:
          config-file    Generate mutations from a configuration file.
          python-file    Mutate a Mininet python file.
          validate-dir   Validate a directory of Mininet topologies.
          validate-file  Validate a Mininet topology python file.
        ```
        
        ### Option 2: Clone the repo:
        
        * Clone this repository
        * In the project directory run `$ sh set-test-env.sh`
            * This creates a temporary venv where mrtopo will be installed
        * Run `$ mrtopo --help`
            * If this doesn't work try `$ source tmpenv/bin/activate` and retry `$ mrtopo --help`
        
        ## Examples
        
        1. Copy the `/examples/temp_topo.py` code to a local python file named `temp_topo.py`
        2. Run `mrtopo python-file -f temp_topo.py`
        3. This should create a `MrTopoGenerated` folder containing the mutated topology files generated from the `temp_topo.py` file.
        4. Replace `temp_topo.py` with the path to your Mininet topology file.
        
        ## Further Notes
        
        Further documentation is available on the [MrTopo GitHub pages site.](https://faizchishtie.github.io/mrtopo/)
        
        ## Links
        
        * [PyPi MrTopo Package](https://pypi.org/project/mrtopo/)
        
Keywords: topology network startup
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.0
Description-Content-Type: text/markdown
