Edit README.md

This commit is contained in:
Larry Kim 2013-05-14 17:17:59 +09:00
parent c6c48f56eb
commit 2f951739e1
2 changed files with 29 additions and 1 deletions

View File

@ -1,4 +1,31 @@
python-whois python-whois
============ ============
The WHOIS client, which is developed in Python language, retrieves domain information from the server. The whois library, which is developed in Python language, retrieves domain information from the server.
Quick start
-----------
1. Install the library
python setup.py install
2. Run Python interpreter
python
3. To get whois data of example.com
import whois
whoisData = whois.whois("example.com").query()
whois.whois will return tuple type, which contains whois server address and the whois data.
To parse whois data,
>>> result = whois.parser("example.com", whoisData[1])
Some whois servers of top level domains (like .com and .net) send redirect command in order to let clients to get more information, like address and phone number, from whois server of domain reseller. However, all whois servers have all different data format. So if you want parse the whois data more accurately, I recommend to set "redirect" parameter to `False` when querying, or if you want detailed information, please add data format of the whois server to tld config file and make a pull request.
Config file structure
-----------

1
setup.py Normal file → Executable file
View File

@ -23,4 +23,5 @@ setup(name='whois',
url='http://github.com/relip/python-whois', url='http://github.com/relip/python-whois',
license='MIT', license='MIT',
packages=['whois'], packages=['whois'],
packages_data={"whois": ["tlds/*", "nics/*"]},
) )