url-normalize 2.2.0__tar.gz → 2.2.1__tar.gz

{url_normalize-2.2.0 → url_normalize-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: url-normalize
-Version: 2.2.0
+Version: 2.2.1
 Summary: URL normalization for Python
 Author-email: Nikolay Panov <github@npanov.com>
 License: MIT
@@ -8,7 +8,7 @@ Project-URL: Homepage, https://github.com/niksite/url-normalize
 Project-URL: Repository, https://github.com/niksite/url-normalize
 Project-URL: Issues, https://github.com/niksite/url-normalize/issues
 Project-URL: Changelog, https://github.com/niksite/url-normalize/blob/master/CHANGELOG.md
-Keywords: url,normalization,normalize
+Keywords: url,normalization,normalize,normalizer
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -17,48 +17,67 @@ Provides-Extra: dev
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: pytest-ruff; extra == "dev"
 Requires-Dist: pytest-socket; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
-Requires-Dist: tox; extra == "dev"
 Dynamic: license-file
 
 # url-normalize
 
-[![CI](https://github.com/niksite/url-normalize/actions/workflows/ci.yml/badge.svg)](https://github.com/niksite/url-normalize/actions/workflows/ci.yml)
-[![PyPI](https://github.com/niksite/url-normalize/actions/workflows/publish.yml/badge.svg)](https://github.com/niksite/url-normalize/actions/workflows/publish.yml)
+[![tests](https://github.com/niksite/url-normalize/actions/workflows/ci.yml/badge.svg)](https://github.com/niksite/url-normalize/actions/workflows/ci.yml)
+[![Coveralls](https://img.shields.io/coveralls/github/niksite/url-normalize/master.svg)](https://coveralls.io/r/niksite/url-normalize)
+[![PyPI](https://img.shields.io/pypi/v/url-normalize.svg)](https://pypi.org/project/url-normalize/)
 
-URI Normalization function:
+A Python library for standardizing and normalizing URLs with support for internationalized domain names (IDN).
 
-* Take care of IDN domains.
-* Always provide the URI scheme in lowercase characters.
-* Always provide the host, if any, in lowercase characters.
-* Only perform percent-encoding where it is essential.
-* Always use uppercase A-through-F characters when percent-encoding.
-* Prevent dot-segments appearing in non-relative URI paths.
-* For schemes that define a default authority, use an empty authority if the
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Python API](#python-api)
+  - [Command Line](#command-line-usage)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Introduction
+
+url-normalize provides a robust URI normalization function that:
+
+- Takes care of IDN domains.
+- Always provides the URI scheme in lowercase characters.
+- Always provides the host, if any, in lowercase characters.
+- Only performs percent-encoding where it is essential.
+- Always uses uppercase A-through-F characters when percent-encoding.
+- Prevents dot-segments appearing in non-relative URI paths.
+- For schemes that define a default authority, uses an empty authority if the
   default is desired.
-* For schemes that define an empty path to be equivalent to a path of "/",
-  use "/".
-* For schemes that define a port, use an empty port if the default is desired
-* All portions of the URI must be utf-8 encoded NFC from Unicode strings
+- For schemes that define an empty path to be equivalent to a path of "/",
+  uses "/".
+- For schemes that define a port, uses an empty port if the default is desired
+- Ensures all portions of the URI are utf-8 encoded NFC from Unicode strings
 
-Inspired by Sam Ruby's [urlnorm.py](<http://intertwingly.net/blog/2004/08/04/Urlnorm>)
+Inspired by Sam Ruby's [urlnorm.py](http://intertwingly.net/blog/2004/08/04/Urlnorm)
 
 ## Features
 
-* IDN (Internationalized Domain Name) support
-* Configurable default scheme (https by default)
-* Configurable default domain for absolute paths
-* Query parameter filtering with allowlists
-* Support for various URL formats including:
-  * Empty string URLs
-  * Double slash URLs (//domain.tld)
-  * Shebang (#!) URLs
-* Cross-version Python compatibility (3.8+)
-* 100% test coverage
-* Modern type hints and string handling
+- **IDN Support**: Full internationalized domain name handling
+- **Configurable Defaults**:
+  - Customizable default scheme (https by default)
+  - Configurable default domain for absolute paths
+- **Query Parameter Control**:
+  - Parameter filtering with allowlists
+  - Support for domain-specific parameter rules
+- **Versatile URL Handling**:
+  - Empty string URLs
+  - Double slash URLs (//domain.tld)
+  - Shebang (#!) URLs
+- **Developer Friendly**:
+  - Cross-version Python compatibility (3.8+)
+  - 100% test coverage
+  - Modern type hints and string handling
 
 ## Installation
 
@@ -68,6 +87,8 @@ pip install url-normalize
 
 ## Usage
 
+### Python API
+
 ```python
 from url_normalize import url_normalize
 
@@ -108,7 +129,7 @@ print(url_normalize("/images/logo.png", default_scheme="http", default_domain="e
 # Output: http://example.com/images/logo.png
 ```
 
-### Command-line usage
+### Command-line Usage
 
 You can also use `url-normalize` from the command line:
 
@@ -145,6 +166,10 @@ $ uvx url-normalize www.foo.com:80/foo
 
 For a complete history of changes, see [CHANGELOG.md](CHANGELOG.md).
 
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
 ## License
 
 MIT License

{url_normalize-2.2.0 → url_normalize-2.2.1}/README.md

@@ -1,38 +1,59 @@
 # url-normalize
 
-[![CI](https://github.com/niksite/url-normalize/actions/workflows/ci.yml/badge.svg)](https://github.com/niksite/url-normalize/actions/workflows/ci.yml)
-[![PyPI](https://github.com/niksite/url-normalize/actions/workflows/publish.yml/badge.svg)](https://github.com/niksite/url-normalize/actions/workflows/publish.yml)
-
-URI Normalization function:
-
-* Take care of IDN domains.
-* Always provide the URI scheme in lowercase characters.
-* Always provide the host, if any, in lowercase characters.
-* Only perform percent-encoding where it is essential.
-* Always use uppercase A-through-F characters when percent-encoding.
-* Prevent dot-segments appearing in non-relative URI paths.
-* For schemes that define a default authority, use an empty authority if the
+[![tests](https://github.com/niksite/url-normalize/actions/workflows/ci.yml/badge.svg)](https://github.com/niksite/url-normalize/actions/workflows/ci.yml)
+[![Coveralls](https://img.shields.io/coveralls/github/niksite/url-normalize/master.svg)](https://coveralls.io/r/niksite/url-normalize)
+[![PyPI](https://img.shields.io/pypi/v/url-normalize.svg)](https://pypi.org/project/url-normalize/)
+
+A Python library for standardizing and normalizing URLs with support for internationalized domain names (IDN).
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Python API](#python-api)
+  - [Command Line](#command-line-usage)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Introduction
+
+url-normalize provides a robust URI normalization function that:
+
+- Takes care of IDN domains.
+- Always provides the URI scheme in lowercase characters.
+- Always provides the host, if any, in lowercase characters.
+- Only performs percent-encoding where it is essential.
+- Always uses uppercase A-through-F characters when percent-encoding.
+- Prevents dot-segments appearing in non-relative URI paths.
+- For schemes that define a default authority, uses an empty authority if the
   default is desired.
-* For schemes that define an empty path to be equivalent to a path of "/",
-  use "/".
-* For schemes that define a port, use an empty port if the default is desired
-* All portions of the URI must be utf-8 encoded NFC from Unicode strings
+- For schemes that define an empty path to be equivalent to a path of "/",
+  uses "/".
+- For schemes that define a port, uses an empty port if the default is desired
+- Ensures all portions of the URI are utf-8 encoded NFC from Unicode strings
 
-Inspired by Sam Ruby's [urlnorm.py](<http://intertwingly.net/blog/2004/08/04/Urlnorm>)
+Inspired by Sam Ruby's [urlnorm.py](http://intertwingly.net/blog/2004/08/04/Urlnorm)
 
 ## Features
 
-* IDN (Internationalized Domain Name) support
-* Configurable default scheme (https by default)
-* Configurable default domain for absolute paths
-* Query parameter filtering with allowlists
-* Support for various URL formats including:
-  * Empty string URLs
-  * Double slash URLs (//domain.tld)
-  * Shebang (#!) URLs
-* Cross-version Python compatibility (3.8+)
-* 100% test coverage
-* Modern type hints and string handling
+- **IDN Support**: Full internationalized domain name handling
+- **Configurable Defaults**:
+  - Customizable default scheme (https by default)
+  - Configurable default domain for absolute paths
+- **Query Parameter Control**:
+  - Parameter filtering with allowlists
+  - Support for domain-specific parameter rules
+- **Versatile URL Handling**:
+  - Empty string URLs
+  - Double slash URLs (//domain.tld)
+  - Shebang (#!) URLs
+- **Developer Friendly**:
+  - Cross-version Python compatibility (3.8+)
+  - 100% test coverage
+  - Modern type hints and string handling
 
 ## Installation
 
@@ -42,6 +63,8 @@ pip install url-normalize
 
 ## Usage
 
+### Python API
+
 ```python
 from url_normalize import url_normalize
 
@@ -82,7 +105,7 @@ print(url_normalize("/images/logo.png", default_scheme="http", default_domain="e
 # Output: http://example.com/images/logo.png
 ```
 
-### Command-line usage
+### Command-line Usage
 
 You can also use `url-normalize` from the command line:
 
@@ -119,6 +142,10 @@ $ uvx url-normalize www.foo.com:80/foo
 
 For a complete history of changes, see [CHANGELOG.md](CHANGELOG.md).
 
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
 ## License
 
 MIT License

{url_normalize-2.2.0 → url_normalize-2.2.1}/pyproject.toml

@@ -1,12 +1,12 @@
 [project]
 name = "url-normalize"
-version = "2.2.0"
+version = "2.2.1"
 description = "URL normalization for Python"
 authors = [{ name = "Nikolay Panov", email = "github@npanov.com" }]
 license = { text = "MIT" }
 readme = "README.md"
 requires-python = ">=3.8"
-keywords = ["url", "normalization", "normalize"]
+keywords = ["url", "normalization", "normalize", "normalizer"]
 dependencies = ["idna>=3.3"]
 
 [project.urls]
@@ -19,16 +19,7 @@ Changelog = "https://github.com/niksite/url-normalize/blob/master/CHANGELOG.md"
 url-normalize = "url_normalize.cli:main"
 
 [project.optional-dependencies]
-dev = [
-  "mypy",
-  "pre-commit",
-  "pytest-cov",
-  "pytest-ruff",
-  "pytest-socket",
-  "pytest",
-  "ruff",
-  "tox",
-]
+dev = ["mypy", "pre-commit", "pytest-cov", "pytest-socket", "pytest", "ruff"]
 
 [tool.ruff]
 target-version = "py38"
@@ -71,11 +62,9 @@ build-backend = "setuptools.build_meta"
 
 [tool.pytest.ini_options]
 addopts = [
-  "--cov-fail-under=100",
   "--cov-report=term-missing:skip-covered",
   "--cov=url_normalize",
   "--disable-socket",
-  "--ruff",
   "-v",
 ]
 python_files = ["tests.py", "test_*.py", "*_tests.py"]

url_normalize-2.2.1/tests/test_deconstruct_url.py

@@ -0,0 +1,40 @@
+"""Deconstruct url tests."""
+
+import pytest
+
+from url_normalize.tools import URL, deconstruct_url
+
+
+@pytest.mark.parametrize(
+    ("url", "expected"),
+    [
+        (
+            "http://site.com",
+            URL(
+                fragment="",
+                host="site.com",
+                path="",
+                port="",
+                query="",
+                scheme="http",
+                userinfo="",
+            ),
+        ),
+        (
+            "http://user@www.example.com:8080/path/index.html?param=val#fragment",
+            URL(
+                fragment="fragment",
+                host="www.example.com",
+                path="/path/index.html",
+                port="8080",
+                query="param=val",
+                scheme="http",
+                userinfo="user@",
+            ),
+        ),
+    ],
+)
+def test_deconstruct_url_result_is_expected(url: str, expected: URL) -> None:
+    """Assert we got expected results from the deconstruct_url function."""
+    result = deconstruct_url(url)
+    assert result == expected, url

url_normalize-2.2.1/tests/test_normalize_fragment.py

@@ -0,0 +1,23 @@
+"""Tests for normalize_fragment function."""
+
+import pytest
+
+from url_normalize.url_normalize import normalize_fragment
+
+
+@pytest.mark.parametrize(
+    ("fragment", "expected"),
+    [
+        ("", ""),
+        ("fragment", "fragment"),
+        ("пример", "%D0%BF%D1%80%D0%B8%D0%BC%D0%B5%D1%80"),
+        ("!fragment", "%21fragment"),
+        ("~fragment", "~fragment"),
+        # Issue #36: Equal sign should not be encoded
+        ("gid=1234", "gid=1234"),
+    ],
+)
+def test_normalize_fragment_result_is_expected(fragment: str, expected: str) -> None:
+    """Assert we got expected results from the normalize_fragment function."""
+    result = normalize_fragment(fragment)
+    assert result == expected, fragment

url_normalize-2.2.1/tests/test_normalize_host.py

@@ -0,0 +1,32 @@
+"""Tests for normalize_host function."""
+
+import pytest
+
+from url_normalize.url_normalize import normalize_host
+
+
+@pytest.mark.parametrize(
+    ("host", "expected"),
+    [
+        # Basic cases
+        ("site.com", "site.com"),
+        ("SITE.COM", "site.com"),
+        ("site.com.", "site.com"),
+        # Cyrillic domains
+        ("пример.испытание", "xn--e1afmkfd.xn--80akhbyknj4f"),
+        # Mixed case with Cyrillic
+        ("ExAmPle.РФ", "example.xn--p1ai"),
+        # IDNA2008 with UTS46
+        ("faß.de", "fass.de"),  # Normalize using transitional rules
+        # Edge cases
+        ("ドメイン.テスト", "xn--eckwd4c7c.xn--zckzah"),  # Japanese
+        ("domain.café", "domain.xn--caf-dma"),  # Latin with diacritic
+        # Normalization tests
+        ("über.example", "xn--ber-goa.example"),  # IDNA 2008 for umlaut
+        ("example。com", "example.com"),  # Normalize full-width punctuation
+    ],
+)
+def test_normalize_host_result_is_expected(host: str, expected: str) -> None:
+    """Assert we got expected results from the normalize_host function."""
+    result = normalize_host(host)
+    assert result == expected, host

url_normalize-2.2.1/tests/test_normalize_path.py

@@ -0,0 +1,44 @@
+"""Tests for normalize_path function."""
+
+import pytest
+
+from url_normalize.url_normalize import normalize_path
+
+
+@pytest.mark.parametrize(
+    ("path", "expected"),
+    [
+        ("..", "/"),
+        ("", "/"),
+        ("/../foo", "/foo"),
+        ("/..foo", "/..foo"),
+        ("/./../foo", "/foo"),
+        ("/./foo", "/foo"),
+        ("/./foo/.", "/foo/"),
+        ("/.foo", "/.foo"),
+        ("/", "/"),
+        ("/foo..", "/foo.."),
+        ("/foo.", "/foo."),
+        ("/FOO", "/FOO"),
+        ("/foo/../bar", "/bar"),
+        ("/foo/./bar", "/foo/bar"),
+        ("/foo//", "/foo/"),
+        ("/foo///bar//", "/foo/bar/"),
+        ("/foo/bar/..", "/foo/"),
+        ("/foo/bar/../..", "/"),
+        ("/foo/bar/../../../../baz", "/baz"),
+        ("/foo/bar/../../../baz", "/baz"),
+        ("/foo/bar/../../", "/"),
+        ("/foo/bar/../../baz", "/baz"),
+        ("/foo/bar/../", "/foo/"),
+        ("/foo/bar/../baz", "/foo/baz"),
+        ("/foo/bar/.", "/foo/bar/"),
+        ("/foo/bar/./", "/foo/bar/"),
+        # Issue #25: we should preserve ? in the path
+        ("/More+Tea+Vicar%3F/discussion", "/More+Tea+Vicar%3F/discussion"),
+    ],
+)
+def test_normalize_path_result_is_expected(path: str, expected: str) -> None:
+    """Assert we got expected results from the normalize_path function."""
+    result = normalize_path(path, "http")
+    assert result == expected, path

url_normalize-2.2.1/tests/test_normalize_port.py

@@ -0,0 +1,26 @@
+"""Tests for normalize_port function."""
+
+import pytest
+
+from url_normalize.url_normalize import normalize_port
+
+
+@pytest.mark.parametrize(
+    ("port", "expected"),
+    [
+        ("8080", "8080"),  # Non-default port
+        ("", ""),  # Empty port
+        ("80", ""),  # Default HTTP port
+        ("string", "string"),  # Non-numeric port (should pass through)
+        # Add more cases as needed, e.g., for HTTPS
+        pytest.param("443", "", id="https_default_port"),
+    ],
+)
+def test_normalize_port_result_is_expected(port: str, expected: str):
+    """Assert we got expected results from the normalize_port function."""
+    # Test with 'http' scheme for most cases
+    scheme = "https" if port == "443" else "http"
+
+    result = normalize_port(port, scheme)
+
+    assert result == expected

url_normalize-2.2.1/tests/test_normalize_scheme.py

@@ -0,0 +1,18 @@
+"""Tests for normalize_scheme function."""
+
+import pytest
+
+from url_normalize.url_normalize import normalize_scheme
+
+
+@pytest.mark.parametrize(
+    ("scheme", "expected"),
+    [
+        ("http", "http"),
+        ("HTTP", "http"),
+    ],
+)
+def test_normalize_scheme_result_is_expected(scheme: str, expected: str) -> None:
+    """Assert we got expected results from the normalize_scheme function."""
+    result = normalize_scheme(scheme)
+    assert result == expected, scheme

url_normalize-2.2.1/tests/test_normalize_userinfo.py

@@ -0,0 +1,21 @@
+"""Tests for normalize_userinfo function."""
+
+import pytest
+
+from url_normalize.url_normalize import normalize_userinfo
+
+
+@pytest.mark.parametrize(
+    ("userinfo", "expected"),
+    [
+        (":@", ""),
+        ("", ""),
+        ("@", ""),
+        ("user:password@", "user:password@"),
+        ("user@", "user@"),
+    ],
+)
+def test_normalize_userinfo_result_is_expected(userinfo: str, expected: str) -> None:
+    """Assert we got expected results from the normalize_userinfo function."""
+    result = normalize_userinfo(userinfo)
+    assert result == expected, userinfo

url_normalize-2.2.1/tests/test_provide_url_scheme.py

@@ -0,0 +1,32 @@
+"""Tests for provide_url_scheme function."""
+
+import pytest
+
+from url_normalize.url_normalize import provide_url_scheme
+
+
+@pytest.mark.parametrize(
+    ("url", "expected"),
+    [
+        ("", ""),
+        ("-", "-"),
+        ("/file/path", "/file/path"),
+        ("//site/path", "https://site/path"),
+        ("ftp://site/", "ftp://site/"),
+        ("site/page", "https://site/page"),
+    ],
+)
+def test_provide_url_scheme_result_is_expected(url: str, expected: str) -> None:
+    """Assert we got expected results from the provide_url_scheme function."""
+    result = provide_url_scheme(url)
+    assert result == expected, url
+
+
+def test_provide_url_scheme_accept_default_scheme_param() -> None:
+    """Assert we could provide default_scheme param other than https."""
+    url = "//site/path"
+    expected = "http://site/path"
+
+    actual = provide_url_scheme(url, default_scheme="http")
+
+    assert actual == expected

url_normalize-2.2.1/tests/test_reconstruct_url.py

@@ -0,0 +1,42 @@
+"""Reconstruct url tests."""
+
+from __future__ import annotations
+
+import pytest
+
+from url_normalize.tools import URL, reconstruct_url
+
+
+@pytest.mark.parametrize(
+    ("url_obj", "expected"),
+    [
+        (
+            URL(
+                fragment="",
+                host="site.com",
+                path="",
+                port="",
+                query="",
+                scheme="http",
+                userinfo="",
+            ),
+            "http://site.com",
+        ),
+        (
+            URL(
+                fragment="fragment",
+                host="www.example.com",
+                path="/path/index.html",
+                port="8080",
+                query="param=val",
+                scheme="http",
+                userinfo="user@",
+            ),
+            "http://user@www.example.com:8080/path/index.html?param=val#fragment",
+        ),
+    ],
+)
+def test_reconstruct_url_result_is_expected(url_obj: URL, expected: str) -> None:
+    """Assert we got expected results from the reconstruct_url function."""
+    result = reconstruct_url(url_obj)
+    assert result == expected, url_obj

{url_normalize-2.2.0 → url_normalize-2.2.1}/url_normalize/__init__.py

@@ -8,6 +8,6 @@ SPDX-License-Identifier: MIT
 from .url_normalize import url_normalize
 
 __license__ = "MIT"
-__version__ = "2.2.0"
+__version__ = "2.2.1"
 
 __all__ = ["url_normalize"]

{url_normalize-2.2.0 → url_normalize-2.2.1}/url_normalize.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: url-normalize
-Version: 2.2.0
+Version: 2.2.1
 Summary: URL normalization for Python
 Author-email: Nikolay Panov <github@npanov.com>
 License: MIT
@@ -8,7 +8,7 @@ Project-URL: Homepage, https://github.com/niksite/url-normalize
 Project-URL: Repository, https://github.com/niksite/url-normalize
 Project-URL: Issues, https://github.com/niksite/url-normalize/issues
 Project-URL: Changelog, https://github.com/niksite/url-normalize/blob/master/CHANGELOG.md
-Keywords: url,normalization,normalize
+Keywords: url,normalization,normalize,normalizer
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -17,48 +17,67 @@ Provides-Extra: dev
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: pytest-ruff; extra == "dev"
 Requires-Dist: pytest-socket; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
-Requires-Dist: tox; extra == "dev"
 Dynamic: license-file
 
 # url-normalize
 
-[![CI](https://github.com/niksite/url-normalize/actions/workflows/ci.yml/badge.svg)](https://github.com/niksite/url-normalize/actions/workflows/ci.yml)
-[![PyPI](https://github.com/niksite/url-normalize/actions/workflows/publish.yml/badge.svg)](https://github.com/niksite/url-normalize/actions/workflows/publish.yml)
+[![tests](https://github.com/niksite/url-normalize/actions/workflows/ci.yml/badge.svg)](https://github.com/niksite/url-normalize/actions/workflows/ci.yml)
+[![Coveralls](https://img.shields.io/coveralls/github/niksite/url-normalize/master.svg)](https://coveralls.io/r/niksite/url-normalize)
+[![PyPI](https://img.shields.io/pypi/v/url-normalize.svg)](https://pypi.org/project/url-normalize/)
 
-URI Normalization function:
+A Python library for standardizing and normalizing URLs with support for internationalized domain names (IDN).
 
-* Take care of IDN domains.
-* Always provide the URI scheme in lowercase characters.
-* Always provide the host, if any, in lowercase characters.
-* Only perform percent-encoding where it is essential.
-* Always use uppercase A-through-F characters when percent-encoding.
-* Prevent dot-segments appearing in non-relative URI paths.
-* For schemes that define a default authority, use an empty authority if the
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Python API](#python-api)
+  - [Command Line](#command-line-usage)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Introduction
+
+url-normalize provides a robust URI normalization function that:
+
+- Takes care of IDN domains.
+- Always provides the URI scheme in lowercase characters.
+- Always provides the host, if any, in lowercase characters.
+- Only performs percent-encoding where it is essential.
+- Always uses uppercase A-through-F characters when percent-encoding.
+- Prevents dot-segments appearing in non-relative URI paths.
+- For schemes that define a default authority, uses an empty authority if the
   default is desired.
-* For schemes that define an empty path to be equivalent to a path of "/",
-  use "/".
-* For schemes that define a port, use an empty port if the default is desired
-* All portions of the URI must be utf-8 encoded NFC from Unicode strings
+- For schemes that define an empty path to be equivalent to a path of "/",
+  uses "/".
+- For schemes that define a port, uses an empty port if the default is desired
+- Ensures all portions of the URI are utf-8 encoded NFC from Unicode strings
 
-Inspired by Sam Ruby's [urlnorm.py](<http://intertwingly.net/blog/2004/08/04/Urlnorm>)
+Inspired by Sam Ruby's [urlnorm.py](http://intertwingly.net/blog/2004/08/04/Urlnorm)
 
 ## Features
 
-* IDN (Internationalized Domain Name) support
-* Configurable default scheme (https by default)
-* Configurable default domain for absolute paths
-* Query parameter filtering with allowlists
-* Support for various URL formats including:
-  * Empty string URLs
-  * Double slash URLs (//domain.tld)
-  * Shebang (#!) URLs
-* Cross-version Python compatibility (3.8+)
-* 100% test coverage
-* Modern type hints and string handling
+- **IDN Support**: Full internationalized domain name handling
+- **Configurable Defaults**:
+  - Customizable default scheme (https by default)
+  - Configurable default domain for absolute paths
+- **Query Parameter Control**:
+  - Parameter filtering with allowlists
+  - Support for domain-specific parameter rules
+- **Versatile URL Handling**:
+  - Empty string URLs
+  - Double slash URLs (//domain.tld)
+  - Shebang (#!) URLs
+- **Developer Friendly**:
+  - Cross-version Python compatibility (3.8+)
+  - 100% test coverage
+  - Modern type hints and string handling
 
 ## Installation
 
@@ -68,6 +87,8 @@ pip install url-normalize
 
 ## Usage
 
+### Python API
+
 ```python
 from url_normalize import url_normalize
 
@@ -108,7 +129,7 @@ print(url_normalize("/images/logo.png", default_scheme="http", default_domain="e
 # Output: http://example.com/images/logo.png
 ```
 
-### Command-line usage
+### Command-line Usage
 
 You can also use `url-normalize` from the command line:
 
@@ -145,6 +166,10 @@ $ uvx url-normalize www.foo.com:80/foo
 
 For a complete history of changes, see [CHANGELOG.md](CHANGELOG.md).
 
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
 ## License
 
 MIT License

{url_normalize-2.2.0 → url_normalize-2.2.1}/url_normalize.egg-info/SOURCES.txt

@@ -30,6 +30,7 @@ url_normalize/normalize_userinfo.py
 url_normalize/param_allowlist.py
 url_normalize/provide_url_domain.py
 url_normalize/provide_url_scheme.py
+url_normalize/py.typed
 url_normalize/tools.py
 url_normalize/url_normalize.py
 url_normalize.egg-info/PKG-INFO

{url_normalize-2.2.0 → url_normalize-2.2.1}/url_normalize.egg-info/requires.txt

@@ -4,8 +4,6 @@ idna>=3.3
 mypy
 pre-commit
 pytest-cov
-pytest-ruff
 pytest-socket
 pytest
 ruff
-tox

url_normalize-2.2.0/tests/test_deconstruct_url.py

@@ -1,35 +0,0 @@
-"""Deconstruct url tests."""
-
-from __future__ import annotations
-
-from typing import Final
-
-from url_normalize.tools import URL, deconstruct_url
-
-EXPECTED_DATA: Final[dict[str, URL]] = {
-    "http://site.com": URL(
-        fragment="",
-        host="site.com",
-        path="",
-        port="",
-        query="",
-        scheme="http",
-        userinfo="",
-    ),
-    "http://user@www.example.com:8080/path/index.html?param=val#fragment": URL(
-        fragment="fragment",
-        host="www.example.com",
-        path="/path/index.html",
-        port="8080",
-        query="param=val",
-        scheme="http",
-        userinfo="user@",
-    ),
-}
-
-
-def test_deconstruct_url_result_is_expected() -> None:
-    """Assert we got expected results from the deconstruct_url function."""
-    for url, expected in EXPECTED_DATA.items():
-        result = deconstruct_url(url)
-        assert result == expected, url

url_normalize-2.2.0/tests/test_normalize_fragment.py

@@ -1,21 +0,0 @@
-"""Tests for normalize_fragment function."""
-
-from url_normalize.url_normalize import normalize_fragment
-
-EXPECTED_DATA = {
-    "": "",
-    "fragment": "fragment",
-    "пример": "%D0%BF%D1%80%D0%B8%D0%BC%D0%B5%D1%80",
-    "!fragment": "%21fragment",
-    "~fragment": "~fragment",
-    # Issue #36: Equal sign should not be encoded
-    "gid=1234": "gid=1234",
-}
-
-
-def test_normalize_fragment_result_is_expected():
-    """Assert we got expected results from the normalize_fragment function."""
-    for url, expected in EXPECTED_DATA.items():
-        result = normalize_fragment(url)
-
-        assert result == expected, url

url_normalize-2.2.0/tests/test_normalize_host.py

@@ -1,29 +0,0 @@
-"""Tests for normalize_host function."""
-
-from url_normalize.url_normalize import normalize_host
-
-EXPECTED_DATA = {
-    # Basic cases
-    "site.com": "site.com",
-    "SITE.COM": "site.com",
-    "site.com.": "site.com",
-    # Cyrillic domains
-    "пример.испытание": "xn--e1afmkfd.xn--80akhbyknj4f",
-    # Mixed case with Cyrillic
-    "ExAmPle.РФ": "example.xn--p1ai",
-    # IDNA2008 with UTS46
-    "faß.de": "fass.de",  # Normalize using transitional rules
-    # Edge cases
-    "ドメイン.テスト": "xn--eckwd4c7c.xn--zckzah",  # Japanese
-    "domain.café": "domain.xn--caf-dma",  # Latin with diacritic
-    # Normalization tests
-    "über.example": "xn--ber-goa.example",  # IDNA 2008 for umlaut
-    "example。com": "example.com",  # Normalize full-width punctuation
-}
-
-
-def test_normalize_host_result_is_expected() -> None:
-    """Assert we got expected results from the normalize_host function."""
-    for url, expected in EXPECTED_DATA.items():
-        result = normalize_host(url)
-        assert result == expected, url

url_normalize-2.2.0/tests/test_normalize_path.py

@@ -1,42 +0,0 @@
-"""Tests for normalize_path function."""
-
-from url_normalize.url_normalize import normalize_path
-
-EXPECTED_DATA = {
-    "..": "/",
-    "": "/",
-    "/../foo": "/foo",
-    "/..foo": "/..foo",
-    "/./../foo": "/foo",
-    "/./foo": "/foo",
-    "/./foo/.": "/foo/",
-    "/.foo": "/.foo",
-    "/": "/",
-    "/foo..": "/foo..",
-    "/foo.": "/foo.",
-    "/FOO": "/FOO",
-    "/foo/../bar": "/bar",
-    "/foo/./bar": "/foo/bar",
-    "/foo//": "/foo/",
-    "/foo///bar//": "/foo/bar/",
-    "/foo/bar/..": "/foo/",
-    "/foo/bar/../..": "/",
-    "/foo/bar/../../../../baz": "/baz",
-    "/foo/bar/../../../baz": "/baz",
-    "/foo/bar/../../": "/",
-    "/foo/bar/../../baz": "/baz",
-    "/foo/bar/../": "/foo/",
-    "/foo/bar/../baz": "/foo/baz",
-    "/foo/bar/.": "/foo/bar/",
-    "/foo/bar/./": "/foo/bar/",
-    # Issue #25: we should preserve ? in the path
-    "/More+Tea+Vicar%3F/discussion": "/More+Tea+Vicar%3F/discussion",
-}
-
-
-def test_normalize_path_result_is_expected():
-    """Assert we got expected results from the normalize_path function."""
-    for url, expected in EXPECTED_DATA.items():
-        result = normalize_path(url, "http")
-
-        assert result == expected, url

url_normalize-2.2.0/tests/test_normalize_port.py

@@ -1,13 +0,0 @@
-"""Tests for normalize_port function."""
-
-from url_normalize.url_normalize import normalize_port
-
-EXPECTED_DATA = {"8080": "8080", "": "", "80": "", "string": "string"}
-
-
-def test_normalize_port_result_is_expected():
-    """Assert we got expected results from the normalize_port function."""
-    for url, expected in EXPECTED_DATA.items():
-        result = normalize_port(url, "http")
-
-        assert result == expected, url

url_normalize-2.2.0/tests/test_normalize_scheme.py

@@ -1,13 +0,0 @@
-"""Tests for normalize_scheme function."""
-
-from url_normalize.url_normalize import normalize_scheme
-
-EXPECTED_DATA = {"http": "http", "HTTP": "http"}
-
-
-def test_normalize_scheme_result_is_expected():
-    """Assert we got expected results from the normalize_scheme function."""
-    for url, expected in EXPECTED_DATA.items():
-        result = normalize_scheme(url)
-
-        assert result == expected, url

url_normalize-2.2.0/tests/test_normalize_userinfo.py

@@ -1,19 +0,0 @@
-"""Tests for normalize_userinfo function."""
-
-from url_normalize.url_normalize import normalize_userinfo
-
-EXPECTED_DATA = {
-    ":@": "",
-    "": "",
-    "@": "",
-    "user:password@": "user:password@",
-    "user@": "user@",
-}
-
-
-def test_normalize_userinfo_result_is_expected():
-    """Assert we got expected results from the normalize_userinfo function."""
-    for url, expected in EXPECTED_DATA.items():
-        result = normalize_userinfo(url)
-
-        assert result == expected, url

url_normalize-2.2.0/tests/test_provide_url_scheme.py

@@ -1,30 +0,0 @@
-"""Tests for provide_url_scheme function."""
-
-from url_normalize.url_normalize import provide_url_scheme
-
-EXPECTED_DATA = {
-    "": "",
-    "-": "-",
-    "/file/path": "/file/path",
-    "//site/path": "https://site/path",
-    "ftp://site/": "ftp://site/",
-    "site/page": "https://site/page",
-}
-
-
-def test_provide_url_scheme_result_is_expected():
-    """Assert we got expected results from the provide_url_scheme function."""
-    for url, expected in EXPECTED_DATA.items():
-        result = provide_url_scheme(url)
-
-        assert result == expected, url
-
-
-def test_provide_url_scheme_accept_default_scheme_param():
-    """Assert we could provide default_scheme param other than https."""
-    url = "//site/path"
-    expected = "http://site/path"
-
-    actual = provide_url_scheme(url, default_scheme="http")
-
-    assert actual == expected

url_normalize-2.2.0/tests/test_reconstruct_url.py

@@ -1,41 +0,0 @@
-"""Reconstruct url tests."""
-
-from __future__ import annotations
-
-from typing import Final
-
-from url_normalize.tools import URL, reconstruct_url
-
-EXPECTED_DATA: Final[tuple[tuple[URL, str], ...]] = (
-    (
-        URL(
-            fragment="",
-            host="site.com",
-            path="",
-            port="",
-            query="",
-            scheme="http",
-            userinfo="",
-        ),
-        "http://site.com",
-    ),
-    (
-        URL(
-            fragment="fragment",
-            host="www.example.com",
-            path="/path/index.html",
-            port="8080",
-            query="param=val",
-            scheme="http",
-            userinfo="user@",
-        ),
-        "http://user@www.example.com:8080/path/index.html?param=val#fragment",
-    ),
-)
-
-
-def test_deconstruct_url_result_is_expected() -> None:
-    """Assert we got expected results from the deconstruct_url function."""
-    for url, expected in EXPECTED_DATA:
-        result = reconstruct_url(url)
-        assert result == expected, url