PKG-INFO

Metadata-Version: 1.1
Name: tld
Version: 0.9
Summary: Extract the top level domain (TLD) from the URL given.
Home-page: https://github.com/barseghyanartur/tld
Author: Artur Barseghyan
Author-email: artur.barseghyan@gmail.com
License: MPL 1.1/GPL 2.0/LGPL 2.1
Description: ===
        tld
        ===
        Extract the top level domain (TLD) from the URL given. List of TLD names is
        taken from `Mozilla
        <http://mxr.mozilla.org/mozilla/source/netwerk/dns/src/effective_tld_names.dat?raw=1>`_.
        
        Optionally raises exceptions on non-existing TLDs or silently fails (if
        ``fail_silently`` argument is set to True).
        
        Prerequisites
        =============
        - Python 2.6, 2.7, 3.4, 3.5, 3.6 and PyPy
        
        Documentation
        =============
        Documentation is available on `Read the Docs
        <http://tld.readthedocs.io/>`_.
        
        Installation
        ============
        Latest stable version on PyPI:
        
        .. code-block:: sh
        
            pip install tld
        
        Or latest stable version from GitHub:
        
        .. code-block:: sh
        
            pip install https://github.com/barseghyanartur/tld/archive/stable.tar.gz
        
        Or latest stable version from BitBucket:
        
        .. code-block:: sh
        
            pip install https://bitbucket.org/barseghyanartur/tld/get/stable.tar.gz
        
        Usage examples
        ==============
        Get the TLD name **as string** from the URL given:
        
        .. code-block:: python
        
            from tld import get_tld, get_fld
        
            get_tld("http://www.google.co.uk")
            # 'co.uk'
        
            get_fld("http://www.google.co.uk")
            # 'google.co.uk'
        
            get_tld("http://www.google.idontexist", fail_silently=True)
            # None
        
            get_fld("http://www.google.idontexist", fail_silently=True)
            # None
        
        If you wish, you could get the TLD as **an object**:
        
        .. code-block:: python
        
            from tld import get_tld
        
            res = get_tld("http://some.subdomain.google.co.uk", as_object=True)
        
            res
            # 'co.uk'
        
            res.subdomain
            # 'some.subdomain'
        
            res.domain
            # 'google'
        
            res.tld
            # 'co.uk'
        
            res.fld
            # 'google.co.uk'
        
        Get TLD name, **ignoring the missing protocol**:
        
        .. code-block:: python
        
            from tld import get_tld, get_fld
        
            get_tld("www.google.co.uk", fix_protocol=True)
            # 'co.uk'
        
            get_fld("www.google.co.uk", fix_protocol=True)
            # 'google.co.uk'
        
        Update the list of TLD names
        ============================
        To update/sync the tld names with the most recent version run the following
        from your terminal:
        
        .. code-block:: sh
        
            update-tld-names
        
        Or simply do:
        
        .. code-block:: python
        
            from tld.utils import update_tld_names
        
            update_tld_names()
        
        Troubleshooting
        ===============
        If somehow domain names listed `here
        <http://mxr.mozilla.org/mozilla/source/netwerk/dns/src/effective_tld_names.dat?raw=1>`_
        are not recognised, make sure you have the most recent version of TLD names in
        your virtual environment:
        
        .. code-block:: sh
        
            update-tld-names
        
        Testing
        =======
        Simply type:
        
        .. code-block:: sh
        
            ./runtests.py
        
        Or use tox:
        
        .. code-block:: sh
        
            tox
        
        Or use tox to check specific env:
        
        .. code-block:: sh
        
            tox -e py36
        
        Writing documentation
        =====================
        
        Keep the following hierarchy.
        
        .. code-block:: text
        
            =====
            title
            =====
        
            header
            ======
        
            sub-header
            ----------
        
            sub-sub-header
            ~~~~~~~~~~~~~~
        
            sub-sub-sub-header
            ^^^^^^^^^^^^^^^^^^
        
            sub-sub-sub-sub-header
            ++++++++++++++++++++++
        
            sub-sub-sub-sub-sub-header
            **************************
        
        License
        =======
        MPL 1.1/GPL 2.0/LGPL 2.1
        
        Support
        =======
        For any issues contact me at the e-mail given in the `Author`_ section.
        
        Author
        ======
        Artur Barseghyan <artur.barseghyan@gmail.com>
        
Keywords: tld,top level domain names,python
Platform: UNKNOWN
Classifier: Programming Language :: Python
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: Programming Language :: Python :: 3.6
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Internet
Classifier: License :: OSI Approved :: Mozilla Public License 1.1 (MPL 1.1)
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)