Metadata-Version: 1.1
Name: ipwhois
Version: 0.13.0
Summary: Retrieve and parse whois data for IPv4 and IPv6 addresses.
Home-page: https://github.com/secynic/ipwhois
Author: Philip Hane
Author-email: secynic AT gmail DOT com
License: Copyright (c) 2013, 2014, 2015, 2016 Philip Hane
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer. 
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution. 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Download-URL: https://github.com/secynic/ipwhois/tarball/master
Description: =======
        ipwhois
        =======
        
        ipwhois is a Python package focused on retrieving and parsing whois data
        for IPv4 and IPv6 addresses.
        
        RDAP is the recommended query method as of v0.11.0. Please see the
        `upgrade info <https://github.com/secynic/ipwhois/blob/master/RDAP.rst
        #upgrading-from-0-10-to-0-11>`_.
        
        IPWhois.lookup() is deprecated as of v0.12.0 and will be removed. Legacy whois
        lookups were moved to IPWhois.lookup_whois().
        
        Features
        ========
        
        * Parses a majority of whois fields in to a standard dictionary
        * IPv4 and IPv6 support
        * Referral whois support
        * Supports RDAP queries (recommended method, more detailed information)
        * Proxy support for RDAP queries
        * Recursive network parsing for IPs with parent/children networks listed
        * Python 2.6+ and 3.3+ supported
        * Useful set of utilities
        * BSD license
        * 100% core code coverage (See '# pragma: no cover' for exclusions)
        * Human readable field translations
        * Full CLI for IPWhois with optional ANSI colored console output.
        
        Links
        =====
        
        Documentation
        -------------
        
        https://secynic.github.io/ipwhois
        
        Examples
        --------
        
        https://github.com/secynic/ipwhois/tree/master/ipwhois/examples
        
        Github
        ------
        
        https://github.com/secynic/ipwhois
        
        Pypi
        ----
        
        https://pypi.python.org/pypi/ipwhois
        
        Changes
        -------
        
        https://secynic.github.io/ipwhois/CHANGES.html
        
        Dependencies
        ============
        
        Python 2.6, 2.7::
        
            dnspython
            ipaddr
        
        Python 3.3+::
        
            dnspython3
        
        Installing
        ==========
        
        Latest version from PyPi::
        
        	pip install --upgrade ipwhois
        
        Latest version from GitHub::
        
        	pip install -e git+https://github.com/secynic/ipwhois@master#egg=ipwhois
        
        Firewall Ports
        ==============
        
        ipwhois needs some outbound firewall ports opened from your host/server.
        
        :ASN (DNS): 53/tcp
        :ASN (Whois): 43/tcp
        :ASN (HTTP):
            80/tcp
        
            443/tcp (Pending)
        :RDAP (HTTP):
            80/tcp
        
            443/tcp (Pending)
        :Legacy Whois: 43/tcp
        :Get Host: 43/tcp
        
        API
        ===
        
        IPWhois (main class)
        --------------------
        
        ipwhois.IPWhois is the base class for wrapping RDAP and Legacy Whois lookups.
        Instantiate this object, then call one of the lookup functions:
        
        `RDAP (HTTP) - IPWhois.lookup_rdap() <#rdap-http>`_
        OR
        `Legacy Whois - IPWhois.lookup_whois() <#legacy-whois>`_
        
        Input
        ^^^^^
        
        +--------------------+--------+-----------------------------------------------+
        | **Key**            |**Type**| **Description**                               |
        +--------------------+--------+-----------------------------------------------+
        | address            | String | An IPv4 or IPv6 address as a string, integer, |
        |                    |        | IPv4Address, or IPv6Address.                  |
        +--------------------+--------+-----------------------------------------------+
        | timeout            | Int    | The default timeout for socket connections    |
        |                    |        | in seconds.                                   |
        +--------------------+--------+-----------------------------------------------+
        | proxy_opener       | Object | The urllib.request.OpenerDirector request for |
        |                    |        | proxy support or None.                        |
        +--------------------+--------+-----------------------------------------------+
        | allow_permutations | Bool   | Allow net.Net() to use additional methods if  |
        |                    |        | DNS lookups to Cymru fail.                    |
        +--------------------+--------+-----------------------------------------------+
        
        RDAP (HTTP)
        -----------
        
        IPWhois.lookup_rdap() is the recommended lookup method. RDAP provides a
        far better data structure than legacy whois and REST lookups (previous
        implementation). RDAP queries allow for parsing of contact information and
        details for users, organizations, and groups. RDAP also provides more detailed
        network information.
        
        RDAP documentation:
        
        https://secynic.github.io/ipwhois/RDAP.html
        
        https://github.com/secynic/ipwhois/blob/master/RDAP.rst
        
        Legacy Whois
        ------------
        
        IPWhois.lookup() is deprecated as of v0.12.0 and will be removed. Legacy whois
        lookups were moved to IPWhois.lookup_whois().
        
        Legacy Whois documentation:
        
        https://secynic.github.io/ipwhois/WHOIS.html
        
        https://github.com/secynic/ipwhois/blob/master/WHOIS.rst
        
        Utilities
        ---------
        
        Utilities documentation:
        
        https://secynic.github.io/ipwhois/UTILS.html
        
        https://github.com/secynic/ipwhois/blob/master/UTILS.rst
        
        Scripts
        -------
        
        CLI documentation:
        
        https://secynic.github.io/ipwhois/CLI.html
        
        https://github.com/secynic/ipwhois/blob/master/CLI.rst
        
        IP Reputation Support
        =====================
        
        This feature is under consideration. Take a look at TekDefense's Automater:
        
        `TekDefense-Automater <https://github.com/1aN0rmus/TekDefense-Automater>`_
        
        Domain Support
        ==============
        
        There are no plans for domain whois support in this project.
        
        Look at Sven Slootweg's
        `python-whois <https://github.com/joepie91/python-whois>`_ for a library with
        domain support.
        
        Special Thanks
        ==============
        
        Thank you JetBrains for the PyCharm open source support!
        
        
        Changelog
        =========
        
        0.13.0 (2016-04-18)
        -------------------
        
        - Added events_actor parsing for RDAP results.
        - Added example for caching data via Redis (#81)
        - Added normalization (human-readable field information) in hr.py (#47)
        - README word wrap fix (#102)
        - Fixed bug in exception handling for ASN HTTP lookups.
        - Fixed bug in IPWhois.lookup_rdap() that caused ASN HTTP lookup responses to
          be used in place of RDAP responses.
        - Added new function Net.get_asn_http() and migrated code from
          Net.lookup_asn() + new tests.
        - Fixed bug in ASN HTTP fallback lookups for DNIC (#108).
        - Added new parameter extra_org_map in Net.get_asn_http(), Net.lookup_asn(),
          and IPWhois.lookup*() (#108).
        - Fixed _RDAPCommon.summarize_notices() None check - changed len() to all().
        - Added CLI (ipwhois_cli.py) - #46. Installed to your environments Scripts dir.
          This is a wrapper for ipwhois.py (IPWhois). Utils CLI will be in a future
          release (#121).
        - Documentation split up and added more detail (#81).
        
        0.12.0 (2016-03-28)
        -------------------
        
        - Added headers parameter to ipwhois.Net.get_http_json() (issue #98).
        - Fixed ASN HTTP lookup (fallback) Accept headers (issue #98).
        - Fixed HTTP decoding, set to utf-8 (italomaia - issue #97)
        - IPWhois.lookup() deprecated (issue #96), and will be removed in a future
          release (TBD). Use IPWhois.lookup_whois() instead.
        - Added rate_limit_timeout parameter (issue #99) to Net.get_http_json(),
          IPWhois.lookup_rdap(), and RDAP.lookup(). New exception HTTPRateLimitError.
        - Added new parameter asn_alts to Net.lookup_asn(), IPWhois.lookup_rdap() and
          IPWhois.lookup(). Takes an array of lookup types to attempt if the
          ASN dns lookup fails. Allow permutations must be enabled. Defaults to all
          ['whois', 'http'] (issue #93).
        - Fixed socket exception handling in Net.get_http_json() for Python 2.6.
        - Fixed assertIsInstance for Python 2.6 tests (issue #100). Implemented
          unittest._formatMessage and unittest.util.safe_repr for Python 2.6.
        - Moved TestCommon to tests\\__init__.py to avoid duplicate code.
        - Replaced remaining % with str.format (issue #95).
        
        0.11.2 (2016-02-25)
        -------------------
        
        - Added allow_permutations parameter (bool) to net.Net() and ipwhois.IPWhois()
          to allow alternate ASN lookups if DNS lookups fail. (FirefighterBlu3)
        - Fixed ASN DNS resolver timeout/retry_count support. Retry count is used as a
          multiplier of timeout, to determine a limetime interval. (FirefighterBlu3)
        - Fixed bug where remarks would return None if missing a title.
        - Added CONTRIBUTING.rst
        - Added tests
        
        0.11.1 (2015-12-17)
        -------------------
        
        - Re-added CIDR calculation for RDAP lookups.
        - Improved tests - core code coverage now 100%. See '# pragma: no cover' for
          exclusions. A few bugs were identified in the process, detailed below.
        - Moved IP zero stripping from rdap._RDAPNetwork.parse() to new helper function
          utils.ipv4_lstrip_zeros().
        - Moved CIDR calculation from rdap._RDAPNetwork.parse() to new helper function
          utils.calculate_cidr().
        - Fixed utils.ipv4_is_defined() if statement ordering for RFC 1918 conflict.
        - Fixed utils.ipv6_is_defined() if statement ordering for Unspecified and
          Loopback (conflict with Reserved).
        - Added is_offline parameter to whois.Whois.lookup() primarily for testing.
        - Fixed bug in whois.Whois._parse_fields() that attempted to parse 'val2' of
          regex, which is no longer used. Also fixed the expected Exception to be
          IndexError.
        - Fixed bug in ipwhois.IPWhois.lookup() where the argument order was mixed up,
          causing referral lookups to be skipped when get_referral=True.
        - Fixed bug in rdap._RDAPCommon.summarize_notices() output for links.
        - Fixed bug in root entity iteration exception handling in rdap.RDAP.lookup().
        
        0.11.0 (2015-11-02)
        -------------------
        
        - Support for REST lookups replaced with RDAP.
        - Split code for a more structured system (net, whois, rdap, exceptions).
        - Tests match the data new structure.
        - Split tests for online and offline testing.
        - Performance enhancements for parsing.
        - Added an optional bootstrap parameter for RDAP lookups, in order to replace
          ASN lookups or use both. Will default to False. Afrinic is currently not
          supported, so I would not use this for now. ARIN acknowledged my issue
          for this, and will be adding support back in for Afrinic bootstrap.
        - Added field_list parameter (inclusion list) for WHOIS lookups.
        - Added logging.
        - Added examples directory.
        
        0.10.3 (2015-08-14)
        -------------------
        
        - Fixed LACNIC lookup_rws() queries, since they switched to RDAP. This is
          temporary to get it working until the major library transition to RDAP and
          new parsed formatting is complete.
        
        0.10.2 (2015-05-19)
        -------------------
        
        - Fixed APNIC parsing for updated field.
        - Fixed datetime parsing and validation when Zulu (Z) is appended.
        - Added RIPE parsing for created and updated fields (whois and RWS).
        - Removed unnecessary parentheses in IPWhois class declaration.
        - Some documentation and comment tweaking to work with Sphinx.
        - Minor PEP 8 tweaks.
        
        0.10.1 (2015-02-09)
        -------------------
        
        - Fixed setup.py bug.
        
        0.10.0 (2015-02-09)
        -------------------
        
        - Added .csv support for country code source. You can no longer download
          country code information from iso.org.
        - Added support for IPv4Address or IPv6Address as the address arg in IPWhois.
        - Fixed file open encoding bug. Moved from open to io.open.
        - Fixed parameter in IPWhois ip defined checks.
        - Fixed TestIPWhois.test_ip_invalid() assertions.
Keywords: Python,WHOIS,RWhois,ASN,IP Address,IP,IPv4,IPv6,IETF,REST,Arin,Ripe,Apnic,Lacnic,Afrinic,NIC,RDAP,RIR
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet
Classifier: Topic :: Software Development
