README.rst
author Richard Penman
Tue, 01 Sep 2015 11:52:23 +0800
changeset 57 1f14b45214eb
parent 55 bc23472ae284
child 61 c391985a797b
permissions -rw-r--r--
added rf class issue #72
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
55
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
     1
Goal
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
     2
====
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
     3
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
     4
-  Create a simple importable Python module which will produce parsed
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
     5
   WHOIS data for a given domain.
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
     6
-  Able to extract data for all the popular TLDs (com, org, net, ...)
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
     7
-  Query a WHOIS server directly instead of going through an
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
     8
   intermediate web service like many others do.
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
     9
-  Works with Python 2.4+ and no external dependencies
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    10
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    11
Example
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    12
=======
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    13
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    14
.. sourcecode:: python
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    15
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    16
    >>> import whois
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    17
    >>> w = whois.whois('webscraping.com')
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    18
    >>> w.expiration_date  # dates converted to datetime object
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    19
    datetime.datetime(2013, 6, 26, 0, 0)
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    20
    >>> w.text  # the content downloaded from whois server
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    21
    u'\nWhois Server Version 2.0\n\nDomain names in the .com and .net 
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    22
    ...'
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    23
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    24
    >>> print w  # print values of all found attributes
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    25
    creation_date: 2004-06-26 00:00:00
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    26
    domain_name: [u'WEBSCRAPING.COM', u'WEBSCRAPING.COM']
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    27
    emails: [u'WEBSCRAPING.COM@domainsbyproxy.com', u'WEBSCRAPING.COM@domainsbyproxy.com']
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    28
    expiration_date: 2013-06-26 00:00:00
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    29
    ...
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    30
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    31
Install
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    32
=======
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    33
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    34
Install from pypi:
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    35
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    36
.. sourcecode:: python
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    37
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    38
    pip install python-whois
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    39
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    40
Or checkout latest version from repository:
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    41
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    42
.. sourcecode:: python
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    43
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    44
    hg clone https://bitbucket.org/richardpenman/pywhois
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    45
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    46
Contact
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    47
=======
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    48
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    49
You can post ideas or patches here:
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    50
https://bitbucket.org/richardpenman/pywhois/issues
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    51
bc23472ae284 converted README from markdown to RST for pypi
Richard Penman
parents:
diff changeset
    52
Thanks to the many who have sent patches for additional domains!