Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mozilla/bleach

Bleach is an allowed-list-based HTML sanitizing library that escapes or strips markup and attributes
https://github.com/mozilla/bleach

Last synced: 5 days ago
JSON representation

Bleach is an allowed-list-based HTML sanitizing library that escapes or strips markup and attributes

Awesome Lists containing this project

README 

        
======

Bleach

======



.. image:: https://github.com/mozilla/bleach/workflows/Test/badge.svg

   :target: https://github.com/mozilla/bleach/actions?query=workflow%3ATest



.. image:: https://github.com/mozilla/bleach/workflows/Lint/badge.svg

   :target: https://github.com/mozilla/bleach/actions?query=workflow%3ALint



.. image:: https://badge.fury.io/py/bleach.svg

   :target: http://badge.fury.io/py/bleach



**NOTE: 2023-01-23: Bleach is deprecated.** See issue:

``__



Bleach is an allowed-list-based HTML sanitizing library that escapes or strips

markup and attributes.



Bleach can also linkify text safely, applying filters that Django's ``urlize``

filter cannot, and optionally setting ``rel`` attributes, even on links already

in the text.



Bleach is intended for sanitizing text from *untrusted* sources. If you find

yourself jumping through hoops to allow your site administrators to do lots of

things, you're probably outside the use cases. Either trust those users, or

don't.



Because it relies on html5lib_, Bleach is as good as modern browsers at dealing

with weird, quirky HTML fragments. And *any* of Bleach's methods will fix

unbalanced or mis-nested tags.



The version on GitHub_ is the most up-to-date and contains the latest bug

fixes. You can find full documentation on `ReadTheDocs`_.



:Code:           https://github.com/mozilla/bleach

:Documentation:  https://bleach.readthedocs.io/

:Issue tracker:  https://github.com/mozilla/bleach/issues

:License:        Apache License v2; see LICENSE file



Reporting Bugs

==============



For regular bugs, please report them `in our issue tracker

`_.



If you believe that you've found a security vulnerability, please `file a secure

bug report in our bug tracker

`_

or send an email to *security AT mozilla DOT org*.



For more information on security-related bug disclosure and the PGP key to use

for sending encrypted mail or to verify responses received from that address,

please read our wiki page at

``_.



Security

========



Bleach is a security-focused library.



We have a responsible security vulnerability reporting process. Please use

that if you're reporting a security issue.



Security issues are fixed in private. After we land such a fix, we'll do a

release.



For every release, we mark security issues we've fixed in the ``CHANGES`` in

the **Security issues** section. We include any relevant CVE links.



Installing Bleach

=================



Bleach is available on PyPI_, so you can install it with ``pip``::



    $ pip install bleach



Upgrading Bleach

================



.. warning::



   Before doing any upgrades, read through `Bleach Changes

   `_ for backwards

   incompatible changes, newer versions, etc.



   Bleach follows `semver 2`_ versioning. Vendored libraries will not

   be changed in patch releases.



Basic use

=========



The simplest way to use Bleach is:



.. code-block:: python



    >>> import bleach



    >>> bleach.clean('an evil() example')

    u'an <script>evil()</script> example'



    >>> bleach.linkify('an http://example.com url')

    u'an http://example.com url'



Code of Conduct

===============



This project and repository is governed by Mozilla's code of conduct and

etiquette guidelines. For more details please see the `CODE_OF_CONDUCT.md

`_



.. _html5lib: https://github.com/html5lib/html5lib-python

.. _GitHub: https://github.com/mozilla/bleach

.. _ReadTheDocs: https://bleach.readthedocs.io/

.. _PyPI: https://pypi.org/project/bleach/

.. _semver 2: https://semver.org/