From 2f951739e1c561367766abe9d58925949ef61a42 Mon Sep 17 00:00:00 2001 From: Larry Kim Date: Tue, 14 May 2013 17:17:59 +0900 Subject: [PATCH] Edit README.md --- README.md | 29 ++++++++++++++++++++++++++++- setup.py | 1 + 2 files changed, 29 insertions(+), 1 deletion(-) mode change 100644 => 100755 setup.py diff --git a/README.md b/README.md index 475d37e..a93c0fc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,31 @@ python-whois ============ -The WHOIS client, which is developed in Python language, retrieves domain information from the server. \ No newline at end of file +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 +----------- diff --git a/setup.py b/setup.py old mode 100644 new mode 100755 index bb35ae9..b3d519a --- a/setup.py +++ b/setup.py @@ -23,4 +23,5 @@ setup(name='whois', url='http://github.com/relip/python-whois', license='MIT', packages=['whois'], + packages_data={"whois": ["tlds/*", "nics/*"]}, )