Metadata-Version: 2.1
Name: no-more-query-string
Version: 0.0.3
Summary: Remove unneccessary query-string from the URL given. Especially fbclid.
Home-page: https://github.com/EltonChou/no-more-query-string
Author: Elton H.Y. Chou
Author-email: plscd748@gmail.com
License: MIT
Project-URL: Bug Tracker, https://github.com/EltonChou/no-more-query-string/issues
Project-URL: Source Code, https://github.com/EltonChou/no-more-query-string/
Project-URL: Changelog, https://github.com/EltonChou/no-more-query-string/blob/main/CHANGELOG.md
Description: [![PyPI](https://img.shields.io/pypi/v/no-more-query-string?style=flat-square)](https://pypi.org/project/no-more-query-string/)
        ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/EltonChou/no-more-query-string/Python%20package/main?style=flat-square)
        [![PyPI - Downloads](https://img.shields.io/pypi/dm/no-more-query-string?style=flat-square)](https://pypi.org/project/no-more-query-string/)
        ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/no-more-query-string?style=flat-square)
        ![PyPI - License](https://img.shields.io/pypi/l/no-more-query-string?style=flat-square)
        
        # no-more-query-string
        Remove *unneccessary* query-string from the URL given. Especially fbclid.
        
        ## Changelog
        + [CHANGELOG](https://github.com/EltonChou/no-more-query-string/blob/main/CHANGELOG.md)
        ## Installation
        ```sh
        pip install no-more-query-string
        ```
        
        ## Usage
        ```py
        from no_more_qs import NoMoreQS
        
        nmq = NoMoreQS()
        url = "https://www.youtube.com/watch?v=h-RHH79hzHI&feature=emb_logo&ab_channel=Ceia"
        
        nmq.clean(url)
        # 'https://www.youtube.com/watch?v=h-RHH79hzHI'
        ```
        or you just want to remove *fbclid*
        ```py
        url = "https://www.youtube.com/watch?v=h-RHH79hzHI&feature=emb_logo&ab_channel=Ceia&fbclid=IwAR2NasdasdasdadasdfP58isTW-c3U"
        
        NoMoreQs.remove_fbclid(url)
        # 'https://www.youtube.com/watch?v=h-RHH79hzHI&feature=emb_logo&ab_channel=Ceia'
        ```
        ## Parameters
        ***fbclid* will be cleaned from all domains**
        ```py
        # default
        NoMoreQS(include_flds=[], exclude_flds=[], strict=True)
        ```
        ### include_flds ( `List[str] | Tuple[str]`=[] )
        
        first-level domains list which are allowed to clean query string.
        ```py
        include_flds = ('youtube.com', 'google.com')
        
        url = "https://www.youtube.com/watch?v=h-RHH79hzHI&feature=emb_logo&ab_channel=Ceia&fbclid=IwAR2NasdasdasdadasdfP58isTW-c3U"
        
        NoMoreQS(include_flds=include_flds).clean(url)
        # 'https://www.youtube.com/watch?v=h-RHH79hzHI'
        ```
        ### exclude_flds ( `List[str] | Tuple[str]`=[] )
        
        first-level domains which are disallowed to clean query string.
        ```py
        exclude_flds = ('youtube.com', 'google.com')
        
        url = "https://www.youtube.com/watch?v=h-RHH79hzHI&feature=emb_logo&ab_channel=Ceia&fbclid=IwAR2NasdasdasdadasdfP58isTW-c3U"
        
        NoMoreQS(exclude_flds=exclude_flds).clean(url)
        # 'https://www.youtube.com/watch?v=h-RHH79hzHI&feature=emb_logo&ab_channel=Ceia'
        
        ```
        ### strict ( `bool`=True )
        if the domain is not in `include_flds` or `exclude_flds`
        + True(default): Remove all unneccessary query string.
        + False: Only remove `fbclid` from query string.
        ```py
        url = "https://www.youtube.com/watch?v=h-RHH79hzHI&feature=emb_logo&ab_channel=Ceia&fbclid=IwAR2NasdasdasdadasdfP58isTW-c3U"
        
        NoMoreQS(strict=True).clean(url)
        # 'https://www.youtube.com/watch?v=h-RHH79hzHI'
        
        NoMoreQS(strict=False).clean(url)
        # 'https://www.youtube.com/watch?v=h-RHH79hzHI&feature=emb_logo&ab_channel=Ceia'
        ```
        ## Method parameters
        ```py
        NoMoreQS().clean(url, allow_og_url=False)
        ```
        ### allow_og_url ( `bool`=False )
        if can't find `canonical url`, will return `og url`
        
Keywords: fbclid,query strings,python
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
