Welcome to w3lib's documentation!
=================================

Overview
========

This is a Python library of web-related functions, such as:

* remove comments, or tags from HTML snippets
* extract base url from HTML snippets
* translate entities on HTML strings
* convert raw HTTP headers to dicts and vice-versa
* construct HTTP auth header
* converting HTML pages to unicode
* sanitize urls (like browsers do)
* extract arguments from urls

The w3lib library is licensed under the BSD license.

Modules
=======

.. toctree::
   :maxdepth: 4

   w3lib

Requirements
============

Python 3.9+

Install
=======

``pip install w3lib``


Tests
=====

:doc:`pytest <pytest:index>` is the preferred way to run tests. Just run:
``pytest`` from the root directory to execute tests using the default Python
interpreter.

:doc:`tox <tox:index>` could be used to run tests for all supported Python
versions. Install it (using 'pip install tox') and then run ``tox`` from
the root directory - tests will be executed for all available
Python interpreters.


Changelog
=========

.. include:: ../NEWS
    :start-line: 3

History
-------

The code of w3lib was originally part of the :doc:`Scrapy framework
<scrapy:index>` but was later stripped out of Scrapy, with the aim of make it
more reusable and to provide a useful library of web functions without
depending on Scrapy.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
