Metadata-Version: 2.1
Name: snappi
Version: 0.1.7
Summary: The Snappi Open Traffic Generator Python Package
Home-page: https://github.com/open-traffic-generator/snappi
Author: ajbalogh
Author-email: andy.balogh@keysight.com
License: MIT
Description: # snappi
        Create test case scripts once using the `snappi` client and run them using a 
        traffic generator that conforms to the [Open Traffic Generator API](https://github.com/open-traffic-generator/models/releases).
        
        ## Install the client
        ```
        pip install snappi
        ```
        
        ## Start scripting
        ```python
        """A simple test that demonstrates the following:
        - A port that transmits an ethernet/vlan/ipv4/tcp flow 
        for a specified duration and a port that receives the packets.
        - While the flow is transmitting the script prints out tx and rx statistics.
        - Once all the packets have been transmitted the script will end. 
        """
        import snappi
        
        api = snappi.Api()
        config = api.config()
        tx_port, rx_port = config.ports \
            .port(name='Tx Port', location='10.36.74.26;02;13')
            .port(name='Rx Port', location='10.36.74.26;02;14')
        flow = config.flows.flow(name='Tx -> Rx Flow')
        flow.tx_rx.port.tx_name = tx_port.name
        flow.tx_rx.port.tx_name = rx_port.name
        flow.packet.ethernet().vlan().ipv4().tcp()
        flow.size.fixed = 128
        flow.rate.pps = 1000
        flow.duration.fixed_packets.packets = 10000
        api.set_config(config)
        
        tx_state = api.transmit_state(state='start')
        api.set_transmit(tx_state)
        
        while True:
            results = api.get_port_results(api.result_portrequest)
            df = pandas.DataFrame.from_dict(results)
            print(df)
            if df.frames_tx.sum() >= flow.duration.fixed_packets.packets:
                break
        ```
Keywords: snappi testing open traffic generator automation
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Testing :: Traffic Generation
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Requires-Python: >=2.7, <4
Description-Content-Type: text/markdown
