Metadata-Version: 2.4
Name: uritools
Version: 6.1.2
Summary: URI parsing, classification and composition
Author-email: Thomas Kemmer <tkemmer@computer.org>
Maintainer-email: Thomas Kemmer <tkemmer@computer.org>
License-Expression: MIT
Project-URL: Homepage, https://github.com/tkem/uritools/
Project-URL: Documentation, https://uritools.readthedocs.io/en/stable/
Project-URL: Source, https://github.com/tkem/uritools/
Project-URL: Repository, https://github.com/tkem/uritools/
Project-URL: Issues, https://github.com/tkem/uritools/issues
Project-URL: Changelog, https://github.com/tkem/uritools/blob/master/CHANGELOG.rst
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Dynamic: license-file

uritools
========================================================================

.. image:: https://img.shields.io/pypi/v/uritools
   :target: https://pypi.org/project/uritools
   :alt: Latest PyPI version

.. image:: https://img.shields.io/github/actions/workflow/status/tkem/uritools/ci.yml
   :target: https://github.com/tkem/uritools/actions/workflows/ci.yml
   :alt: CI build status

.. image:: https://img.shields.io/readthedocs/uritools
   :target: https://uritools.readthedocs.io
   :alt: Documentation build status

.. image:: https://img.shields.io/codecov/c/github/tkem/uritools/master.svg
   :target: https://codecov.io/gh/tkem/uritools
   :alt: Test coverage

.. image:: https://img.shields.io/github/license/tkem/uritools
   :target: https://raw.github.com/tkem/uritools/master/LICENSE
   :alt: License

This module provides RFC 3986 compliant functions for parsing,
classifying and composing URIs and URI references, largely replacing
the Python Standard Library's ``urllib.parse`` module.

.. code-block:: pycon

    >>> from uritools import uricompose, urijoin, urisplit, uriunsplit
    >>> uricompose(scheme='foo', host='example.com', port=8042,
    ...            path='/over/there', query={'name': 'ferret'},
    ...            fragment='nose')
    'foo://example.com:8042/over/there?name=ferret#nose'
    >>> parts = urisplit(_)
    >>> parts.scheme
    'foo'
    >>> parts.authority
    'example.com:8042'
    >>> parts.getport(default=80)
    8042
    >>> parts.getquerydict().get('name')
    ['ferret']
    >>> parts.isuri()
    True
    >>> parts.isabsuri()
    False
    >>> urijoin(uriunsplit(parts), '/right/here?name=swallow#beak')
    'foo://example.com:8042/right/here?name=swallow#beak'

For various reasons, ``urllib.parse`` is not compliant with current
Internet standards.  As stated in `Lib/urllib/parse.py
<https://github.com/python/cpython/blob/3.14/Lib/urllib/parse.py#L22>`_:

    RFC 3986 is considered the current standard and any future changes
    to urllib.parse module should conform with it.  The urllib.parse
    module is currently not entirely compliant with this RFC due to
    defacto scenarios for parsing, and for backward compatibility
    purposes, some parsing quirks from older RFCs are retained.

This module aims to provide fully RFC 3986 compliant replacements for
the most commonly used functions found in ``urllib.parse``.  It also
includes functions for distinguishing between the different forms of
URIs and URI references, and for conveniently creating URIs from their
individual components.


Installation
------------------------------------------------------------------------

uritools is available from PyPI_ and can be installed by running::

  pip install uritools


Project Resources
------------------------------------------------------------------------

- `Documentation`_
- `Issue tracker`_
- `Source code`_
- `Change log`_


Related Projects
------------------------------------------------------------------------

- rfc3986_: A Python implementation of RFC 3986 including validation
  and authority parsing.
- rfc3987_: Parsing and validation of URIs (RFC 3986) and IRIs (RFC
  3987).


License
------------------------------------------------------------------------

Copyright (c) 2014-2026 Thomas Kemmer.

Licensed under the `MIT License`_.


.. _PyPI: https://pypi.org/project/uritools/
.. _Documentation: https://uritools.readthedocs.io/
.. _Issue tracker: https://github.com/tkem/uritools/issues/
.. _Source code: https://github.com/tkem/uritools/
.. _Change log: https://github.com/tkem/uritools/blob/master/CHANGELOG.rst
.. _MIT License: https://raw.github.com/tkem/uritools/master/LICENSE

.. _rfc3986: https://pypi.org/project/rfc3986/
.. _rfc3987: https://pypi.org/project/rfc3987/
