Metadata-Version: 2.0
Name: publicsuffixlist
Version: 0.2.3
Summary: publicsuffixlist implement
Home-page: https://github.com/ko-zu/psl
Author: ko-zu
Author-email: causeless@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Topic :: Internet :: Name Service (DNS)
Classifier: Topic :: Text Processing :: Filters
Classifier: Operating System :: OS Independent

publicsuffixlist
================

`Public Suffix List <https://publicsuffix.org/>`__ parser implementation
for Python 2.5+/3.x.

-  Compliant with `TEST
   DATA <http://mxr.mozilla.org/mozilla-central/source/netwerk/test/unit/data/test_psl.txt?raw=1>`__
-  Support IDN (unicode or punycoded).
-  Support Python2.5+ and Python 3.x
-  Shipped with built-in PSL and update scripts.
-  Written in Pure Python. No library dependencies.

Install
=======

``publicsuffixlist`` can be installed via ``pip`` or ``pip3``.

::

    $ sudo pip install publicsuffixlist

If you are on a bit old destribution (RHEL/CentOS6.x), you may need to
update ``pip`` itself before install.

::

    $ sudo pip install -U pip

Usage
=====

.. code:: python

    from publicsuffixlist import PublicSuffixList

    psl = PublicSuffixList()
    # uses built-in PSL file

    psl.publicsuffix("www.example.com")   # "com"
    # longest public suffix part

    psl.privatesuffix("www.example.com")  # "example.com"
    # shortest domain assigned for a registrant

    psl.privatesuffix("com") # None
    # None if no private (non-public) part found


    psl.publicsuffix("www.example.unknownnewtld") # "unkownnewtld"
    # new TLDs are valid public suffix by default

    psl.publicsuffix(u"www.example.香港")   # u"香港"
    # accept unicode

    psl.publicsuffix("www.example.xn--j6w193g") # "xn--j6w193g"
    # accept punycoded IDNs by default

Latest PSL can be passed as a file like line-iterable object.

.. code:: python

    with open("latest_psl.dat", "rb") as f:
        psl = PublicSuffixList(f)

Works with both Python 2.x and 3.x.

::

    $ python -m publicsuffixlist.test
    ...............
    ----------------------------------------------------------------------
    Ran 15 tests in 2.898s

    OK
    $ python3 -m publicsuffixlist.test
    ...............
    ----------------------------------------------------------------------
    Ran 15 tests in 2.562s

    OK

Drop-in compat code to replace
`publicsuffix <https://pypi.python.org/pypi/publicsuffix/>`__

.. code:: python

    # from publicsuffix import PublicSuffixList
    from publicsuffixlist.compat import PublicSuffixList

    psl = PublicSuffixList()
    psl.suffix("www.example.com")   # return "example.com"
    psl.suffix("com")               # return ""

Limitation
==========

``publicsuffixlist`` do NOT provide domain name validation. In DNS
protocol, most of 8-bit charactors are valid label of domain name. ICANN
compliant registries do not accept domain names that have ``_``
(underscore) but hostname may have. (DMARC records, for example.)

Users need to confirm input is valid based on the users' context.

License
=======

-  This module is licensed under Mozilla Public License 2.0.
-  Public Suffix List maintained by Mozilla Foundation is licensed under
   Mozilla Public License 2.0.
-  PSL testcase dataset is public domain (CC0).

Source / Link
=============

-  Git repository on GitHub (https://github.com/ko-zu/psl)
-  PyPI
   (https://pypi.python.org/pypi?name=publicsuffixlist&:action=display)



