blob: 6e59ebad2d9b4fcbb19fd256277f3a8a263a1a9d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
.. TFTPy documentation master file, created by
sphinx-quickstart on Sun Jul 11 18:48:32 2010.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
TFTPy
=====
TFTPy is a pure python TFTP implementation.
.. toctree::
:maxdepth: 2
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Requirements
============
Python 2.3+, I think. I haven't tested in Python 2.3 in a while but it should
still work. Let me know if it doesn't.
Installation
============
If you download the source distribution, you can simply use distutils to
install, via::
python setup.py build
python setup.py install
Or, as this has been uploaded to pypi, you can use easy_install or pip::
easy_install tftpy
pip install tftpy
Once installed you should have the sample client and server scripts in bin,
and you should be able to import the `tftpy` module.
Examples
========
The simplest tftp client::
import tftpy
client = tftpy.TftpClient('tftp.digitaltorque.ca', 69)
client.download('remote_filename', 'local_filename')
The simplest tftp server::
import tftpy
server = tftpy.TftpServer('/tftpboot')
server.listen('0.0.0.0', 69)
See the sample client and server for slightly more complex examples.
API Documentation
=================
Front-end Modules
-----------------
These modules are the ones that you will need to use directly to implement a
TFTP client or server.
The :mod:`tftpy` Module
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: tftpy
:members:
:show-inheritance:
The `TftpClient` Module
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: tftpy.TftpClient
:members:
:show-inheritance:
The `TftpServer` Module
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: tftpy.TftpServer
:members:
:show-inheritance:
Back-end Modules
----------------
The `TftpPacketFactory` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: tftpy.TftpPacketFactory
:members:
:show-inheritance:
The `TftpPacketTypes` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: tftpy.TftpPacketTypes
:members:
:show-inheritance:
The `TftpShared` Module
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: tftpy.TftpShared
:members:
:show-inheritance:
The `TftpContexts` Module
~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: tftpy.TftpContexts
:members:
:show-inheritance:
The `TftpStates` Module
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: tftpy.TftpStates
:members:
:show-inheritance:
|
