Metadata-Version: 2.1
Name: aiotraceroute
Version: 1.0.0
Summary: Asynchronous traceroute in python
Home-page: https://github.com/NicoAdrian/aiotraceroute
Author: Nicolas Adrian
Author-email: nicolasadrian3@gmail.com
License: MIT
Description: # Simple asynchronous traceroute
        
        Dead simple module which provides asynchronous traceroute with asynchronous dns resolution.
        
        Needs root privileges to be executed (for raw socket)
        
        ## Installation
        `pip install aiotraceroute`
        
        
        ## Example
        
        ```python
        import asyncio
        from aiotraceroute import aiotraceroute
        
        async def main(dest):
            # print hop by hop
            async for n, addr, host in aiotraceroute(dest):
                print(n, addr, host)
        
            # Or run it without iterating
            tr = aiotraceroute(dest)
            result = await tr.run()
            print(result)
        
        asyncio.get_event_loop().run_until_complete(main("google.com"))
        ```
        ## API
        The `aiotraceroute` function takes the following arguments:
          * `dest`: Traceroute destination, can either be a hostname or an IP address.
          * `port`: Destination port (optionnal, default: 33434)
          * `max_hops`: Maximum number of hops before reaching final destination (optionnal, default: 30)
          * `timeout`: Timeout between each hop (optionnal: default: 1s)
          * `packet_size`: Pakcte size in bytes to send each time (optionnal: default: 60)
        
        The `run()` method runs the traceroute and returns a list of tuples containing hop_number, address or None, hostname or None
        ## Python versions
        Python >= 3.6 are supported
        
        ## Tests
        
        This project uses `unittest`.
        Run `make init` then `sudo make test`
        
Keywords: traceroute,async,asyncio
Platform: UNKNOWN
Description-Content-Type: text/markdown
