README.md
1# dnspython
2
3[](https://travis-ci.org/rthalley/dnspython)
4[](https://dnspython.readthedocs.io/en/latest/?badge=latest)
5[](https://badge.fury.io/py/dnspython)
6[](https://codecov.io/gh/rthalley/dnspython)
7[](https://opensource.org/licenses/ISC)
8
9## INTRODUCTION
10
11dnspython is a DNS toolkit for Python. It supports almost all record types. It
12can be used for queries, zone transfers, and dynamic updates. It supports TSIG
13authenticated messages and EDNS0.
14
15dnspython provides both high and low level access to DNS. The high level classes
16perform queries for data of a given name, type, and class, and return an answer
17set. The low level classes allow direct manipulation of DNS zones, messages,
18names, and records.
19
20To see a few of the ways dnspython can be used, look in the `examples/`
21directory.
22
23dnspython is a utility to work with DNS, `/etc/hosts` is thus not used. For
24simple forward DNS lookups, it's better to use `socket.getaddrinfo()` or
25`socket.gethostbyname()`.
26
27dnspython originated at Nominum where it was developed
28to facilitate the testing of DNS software.
29
30## ABOUT THIS RELEASE
31
32This is dnspython 2.1.0.
33Please read
34[What's New](https://dnspython.readthedocs.io/en/stable/whatsnew.html) for
35information about the changes in this release.
36
37## INSTALLATION
38
39* Many distributions have dnspython packaged for you, so you should
40 check there first.
41* If you have pip installed, you can do `pip install dnspython`
42* If not just download the source file and unzip it, then run
43 `sudo python setup.py install`
44* To install the latest from the master branch, run `pip install git+https://github.com/rthalley/dnspython.git`
45
46If you want to use DNS-over-HTTPS, you must run
47`pip install dnspython[doh]`.
48
49If you want to use DNSSEC functionality, you must run
50`pip install dnspython[dnssec]`.
51
52If you want to use internationalized domain names (IDNA)
53functionality, you must run
54`pip install dnspython[idna]`
55
56If you want to use the Trio asynchronous I/O package, you must run
57`pip install dnspython[trio]`.
58
59If you want to use the Curio asynchronous I/O package, you must run
60`pip install dnspython[curio]`.
61
62Note that you can install any combination of the above, e.g.:
63`pip install dnspython[doh,dnssec,idna]`
64
65### Notices
66
67Python 2.x support ended with the release of 1.16.0. dnspython 2.0.0 and
68later only support Python 3.6 and later.
69
70Documentation has moved to
71[dnspython.readthedocs.io](https://dnspython.readthedocs.io).
72
73The ChangeLog has been discontinued. Please see the git history for detailed
74change information.
75
){kind=link}
){kind=link}
){kind=link}
){kind=link}