aiotftp's Introduction

aiotftp

Why?

Because what the world really needed was asynchronous, dynamically routable TFTP.

Seriously, though: it can be useful for testing, and the intended use-case is keeping track of the requests our devices make while under test, and be able to do such testing against potentially many devices simultaneously.

While it can be used for the usual use case of TFTP (moving files into or out of some directory) it’s also possible to provide arbitrary logic to operate on a per-request basis to either

provide a buffer to use as the response to a RRQ
recieve a buffer to do whatever you care to after a WRQ complete

Documentation?

Eventually. Hopefully.

TODO

Right now only OCTET mode is supported; should probably support ASCII as well.

Getting Started

Client example:

import aiotftp

async def main(loop):
    async with aiotftp.read('tftp://example.org/hello') as response:
        contents = await response.data()
        print(contents.decode())

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

import aiotftp

async def main(loop):
    with open('example.txt', 'rb') as fobj:
        await aiotftp.write(args.url, data=fobj)

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

Server example:

import aiotftp

async def read(request):
    if request.filename == 'hello':
        return aiotftp.Response(b'Hello World!\n')
    return aiotftp.FileResponse(request.filename)

async def write(request):
    with open(request.filename, 'wb') as fp:
        async for chunk in await request.accept():
            fp.write(chunk)

async def main(loop):
    server = aiotftp.Server(read, write)
    await loop.create_datagram_endpoint(server, local_addr=('::', 69))

loop = asyncio.get_event_loop()
loop.run_until_complete(main())
loop.run_forever()

aiotftp's People